latestOpenAPI 3.1.02026-08-0817082.3 KB

cac8702ed2aa

Webhooks

Get a webhook by id

Get a webhook.

get/v1/webhooks/{id}

Path parameters

idstring required

The unique identifier of a webhook.

Example:wh123abc45

Response

Success

idstring required

The unique identifier of a webhook.

type'LEARNER_TRAINING_CAMPAIGN_COMPLETED' required

The type of webhook. Currently, only one type, LEARNER_TRAINING_CAMPAIGN_COMPLETED, is supported.

urlstring uri required

The url of the callback that will be triggered when the webhook is fired.

secretKeystring required

The generated secret key that is used to sign requests to the webhook url.

Example response

{
  "id": "wh123abc45",
  "type": "LEARNER_TRAINING_CAMPAIGN_COMPLETED",
  "url": "https://{your-domain}.com/webhooks/ethena",
  "secretKey": "a1b2c3d4e5f6789012345678901234567890123456789012345678901234abcd"
}