Admin Webhooks API

GET all webhooks

A GET query to the webhooks endpoint lists all webhooks of a tenant.

Relative Route	`/webhooks`
`HTTP Verb`	`GET`

When a webhook is executed, the result is logged in the lastRuns property of the webhook.

A GET query returns an array of webhooks structured as follows:

[
  {
    "id": "97261f96-2b43-4e25-a925-5bc56194f1b1",
    "tenantId": "sc-product-dev",
    "label": "kgo webhook",
    "uri": "https://webhook-validation-app.azurewebsites.net/api/trigger",
    "method": "GET",
    "headers": {
      "x-header": "foo"
    },
    "body": "Optional body content",
    "createdBy": null,
    "created": "2024-05-30T12:24:10.8166942+00:00",
    "bodyInclude": null,
    "executionMode": "OnEnd",
    "lastRuns": [
      {
        "timestamp": "2024-05-30T12:13:34.5475897+00:00",
        "success": true
      },
      {
        "timestamp": "2024-05-30T12:12:45.3915352+00:00",
        "success": true
      }
    ],
    "disabled": false
  },
  {
    "id": "b3416378-b998-4d1a-b0dc-93353002674d",
    "tenantId": "sc-product-dev",
    "label": "kgo webhook 4",
    "uri": "https://webhook-validation-app.azurewebsites.net/api/trigger",
    "method": "GET",
    "headers": {
      "tenant": "sc-product-dev"
    },
    "body": "string",
    "createdBy": "kgo",
    "created": "2024-05-13T09:38:09.1718619+00:00",
    "bodyInclude": null,
    "executionMode": "OnEnd",
    "lastRuns": [
      {
        "timestamp": "2024-05-30T12:20:10.7253941+00:00",
        "success": true
      },
      {
        "timestamp": "2024-05-30T12:16:10.9437159+00:00",
        "success": true
      }
    ],
    "disabled": false
  }
]

If you have suggestions for improving this article, let us know!