Create Webhook

This endpoint registers you for Thredd's webhook service and returns a unique Webhook ID. We suggest that you store the Webhook ID for future updates to the notification.

The issuer or program manager will be distinguished by the Thredd webhooks based on the custom claims present in the JWT authorization token.

Sample request - Program Manager or Issuer Level:

POST api/v1/Webhooks
{
   "events": [
        101,
        102,
        112
    ],
   "webhookStatus": "active",
   "config":
   {
        "url": "https://client_domain.com/webhook",
        "customHeaders":
        {
             "key1": "value1",
             "key2": "value2",
             "key3": "value3"
        }
    }
}
        
        

Sample request - Program Manager or Issuer at Product Level:

POST api/v1/Webhooks
{
   "productId": 1234,
   "events": [
        101,
        102,
        112
    ],
   "webhookStatus": "active",
   "config":
   {
        "url": "https://client_domain.com/webhook",
        "customHeaders":
        {
             "key1": "value1",
             "key2": "value2",
             "key3": "value3"
        }
    }
}
👍

Documentation

For more information on how to create a webhook, see Create and View Webhooks.

Language