Create Webhook

This endpoint is used to create a new webhook endpoint.

Request body parameters

Parameters marked are required.

Parameter Name	Description	Type	Example Data
url	The url that the webhook payload should be sent to.	string($url)	https://example.com/webhooks
headerName	The name of any additional http header added to the http request.	string	X-API-Key
headerValue	The value of any additional http header added to the http request.	string	abcdef12345
isActive	Default value is true. When set to false, all subscriptions under this webhook are disabled.	boolean	true

Example request

curl --location --request POST 'https://api.claimsmanagertest.crawco.co.uk/webhooks' \
--header 'Authorization: Bearer {access token} \
--header 'Content-Type: application/json' \
--data-raw '{
        "url": "https://example.com/webhooks",
        "headerName": "X-API-KEY",
        "headerValue": "abcdef12345"
}'

Response body parameters

Parameter Name	Description	Type	Example Data
webhookId	The unique id of the created webhook.	numeric	1

Example response

{
    "webhookId": 1
}