GET webhook

A GET query to the webhooks endpoint returns details on a webhook identified by its id.

Relative Route

/webhooks/<id>

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:

RequestResponse

{
  "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": adn,
  "created": "2024-05-30T12:24:10.8166942+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
}

Do you have some feedback for us?

If you have suggestions for improving this article,