You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/includes/_webhooks.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,8 @@ description of these notifications, see [Events](#events).
5
5
6
6
In the case where the receiving server is unavailable, we will retry the webhook notification up to 10 times with an exponential backoff.
7
7
8
+
9
+
8
10
### The Webhook object
9
11
10
12
> An example Webhook object
@@ -94,7 +96,7 @@ This endpoint retrieves all webhooks.
94
96
Parameter | Required | Description
95
97
--------- | ------- | -----------
96
98
`Authorization` | True | Your Authorization Token.
97
-
`Integration-ID` | True | Integration id.
99
+
`Integration-ID` | True for integration-scoped webhooks | Having integration id in the header will list integration-scoped webhook along with user-scoped webhooks. If it ommited then only user-scoped webhooks will be listed.
98
100
99
101
### Query Parameters
100
102
@@ -163,14 +165,14 @@ This endpoint creates a webhook.
163
165
Parameter | Required | Description
164
166
--------- | ------- | -----------
165
167
`Authorization` | True | Your Authorization Token.
166
-
`Integration-ID` | True | Integration id.
168
+
`Integration-ID` | True for integration-scoped events | The integration id is requied if any of the events that is being registered is integration-scoped event.
@@ -230,7 +232,7 @@ This endpoint retrieves a webhook.
230
232
Parameter | Required | Description
231
233
--------- | ------- | -----------
232
234
`Authorization` | True | Your Authorization Token.
233
-
`Integration-ID` | True | Integration id.
235
+
`Integration-ID` | True for integration-scoped events | The integration id is requied if the webhook that's being retrieved contains one or more integration-scoped events.
234
236
235
237
### URL Parameters
236
238
@@ -299,7 +301,7 @@ This endpoint updates a webhook.
299
301
Parameter | Required | Description
300
302
--------- | ------- | -----------
301
303
`Authorization` | True | Your Authorization Token.
302
-
`Integration-ID` | True | Integration id.
304
+
`Integration-ID` | True for integration-scoped events | The integration id is requied if any of the events that is being updated is integration-scoped event.
`id` | String | False | Previous value | Unique per [Integration](#integrations).
316
+
`id` | String | False | Previous value | Unique per user account or integration.
315
317
`url` | URL | False | Previous value |
316
318
`events` | String[] | False | Previous value |
317
319
`secret_key` | String | False |Previous value |
@@ -387,7 +389,7 @@ This endpoint replaces a webhook.
387
389
Parameter | Required | Description
388
390
--------- | ------- | -----------
389
391
`Authorization` | True | Your Authorization Token.
390
-
`Integration-ID` | True | Integration id.
392
+
`Integration-ID` | True for integration-scoped events | The integration id is requied if any of the events that is being replaced is integration-scoped event.
@@ -451,8 +452,7 @@ This endpoint deletes a webhook.
451
452
Parameter | Required | Description
452
453
--------- | ------- | -----------
453
454
`Authorization` | True | Your Authorization Token.
454
-
`Integration-ID` | True | Integration id.
455
-
455
+
`Integration-ID` | True for integration-scoped events | The integration id is requied if the webhook that is being deleted contains one or more integration-scoped events.
0 commit comments