API Reference version 2
Create global webhook
Create a global webhook.
Dynamically created webhooks have the following restrictions:
- You can only create 10 global webhooks
- You cannot modify a webhook that was declared in the descriptor
Path parameters
Type | Parameter | Description | Required? |
---|---|---|---|
string | key |
Unique key (in the context of the integration) to identify this webhook. Valid length range: |
Request body
Type | Property | Description | Required? |
---|---|---|---|
string | name |
The label for this webhook |
|
string | url |
The URL to send the webhook POST to |
|
string | pattern |
The regular expression pattern to match against messages. Only applicable for message events. |
|
string | authentication |
The authentication method for this webhook Valid values: Defaults to |
|
string | key |
Unique key (in the context of the integration) to identify this webhook. Valid length range: |
|
string | event |
The event to listen for Valid values: |
Type | Property | Description | Required? |
---|---|---|---|
str | int | id |
The unique identifier for the created entity |
|
object | links |
An object with the following properties. |
|
string | self |