Create Webhook

It is an endpoint that allows clients to register for Thredd's webhook service. It returns a Webhook Id that should be saved if the notification needs to be amended in the future.

Sample request:

POST api/v1/Webhooks
{
"productId": 1234,
"events": [
101,
102
],
"webhookStatus": "active",
"config":
{
"url": "https://client_domain.com/webhook",
"customHeaders":
{
"header1": "value1",
"header2": "value2",
"header3": "value3"
}
}
}

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

Documentation

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

Body Params

Register webhook model

Register webhook request body

int32 | null
Defaults to null

Product Id

events
array of int32s | null
Defaults to null

Array for event code(s) associated with the webhook.

events
string | null
^(active|inactive)$
Defaults to active

Status of the webhook

config
object
required

Webhook configurations

Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json