Update a webhook

patch

https://sandbox.uk.rootplatform.com/v1/insurance/webhooks/{webhook_id}

Path Params

webhook_id

string

required

The unique identifier of the webhook.

Body Params

name

string

The webhook name.

description

string

An optional description for the webhook.

verification_token

string

An optional token to set on the webhook, used as an additional verification step for the payload (see the introduction for more details).

url

string

The URL that the webhook will POST payloads to.

subscriptions

array of objects

An array of events that this webhook should subscribe to (see webhook subscriptions for more details). Note: this will replace the existing subscriptions for the webhook.

subscriptions

user_group_id

uuid | null

An optional user group ID to associate with the webhook. When set, only events from entities belonging to this user group will trigger the webhook. Set to null to remove the user group association.

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success