Skip to main content
PUT
Update a Webhook
Change its notificationUrl, the eventTypesList it listens for, its format, its securityToken, or its status. Set status to pause delivery without deleting the subscription. Returns the updated webhook.

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

id
integer<int64>
required

The ID of the webhook.

Body

The webhook request model.

Represents a webhook request.

name
string | null

The name of the webhook.

eventTypesList
enum<integer>[] | null

The events the webhook is subscribed to.

Available options:
10,
11,
12,
20,
21,
22,
30,
31,
32,
40,
41,
42,
50,
51,
52
notificationUrl
string<uri> | null

The URL Raise sends the event payload to. It must accept POST requests over HTTPS.

status
enum<integer>

Whether the webhook is active and receiving events.

Available options:
1,
2
format
enum<integer>

The format to send the payload in.

Available options:
1,
2
securityToken
string | null

The token Raise sends with each delivery so you can verify it came from Raise.

Response

OK

Represents a webhook model.

id
integer<int64>

The unique identifier of the webhook.

name
string | null
read-only

The name of the webhook.

eventTypes
string | null
read-only

The events the webhook is subscribed to.

notificationUrl
string | null
read-only

The URL Raise sends the event payload to.

status
enum<integer>

Whether the webhook is active and receiving events.

Available options:
1,
2
format
enum<integer>

The format the payload is sent in.

Available options:
1,
2
formatDisplay
string | null

The display name of the format.

statusDisplay
string | null

The display name of the status.

securityToken
string | null
read-only

The token Raise sends with each delivery so you can verify it came from Raise.

createdDate
string | null
read-only

The date the webhook was created.

modifiedDate
string | null
read-only

The date the webhook was last modified.

eventTypesList
enum<integer>[] | null

The events the webhook is subscribed to.

Available options:
10,
11,
12,
20,
21,
22,
30,
31,
32,
40,
41,
42,
50,
51,
52
Last modified on October 22, 2026