Skip to main content
GET
Get a Webhook
The response covers its notification URL, status, payload format, and the eventTypesList it is subscribed to.

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.

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 July 28, 2026