Update Webhook — DevRev

Updates the requested webhook.

Request

This endpoint expects an object.

idstringRequiredformat: "id"

ID for the webhook.

actionenumOptional

Allowed values: activatedeactivate

The action to update the webhook’s status.

event_typesobjectOptional

secretstringOptionalformat: "byte"

If provided, updates the secret that’s used when verifying webhook events, which must be between 8 and 32 bytes (inclusive). Otherwise if empty, then a new secret is generated. If the webhook is active, then its status will transition to the ‘unverified’ state and it won’t receive any object events until successfully verified.

urlstringOptionalformat: "text"

The webhook’s updated URL. If the webhook is active, then the webhook’s status will transition to the ‘unverified’ state and it won’t receive any object events until successfully verified.

Response

The response to updating the webhook.

webhookobject

Errors

1 curl -X POST https://api.devrev.ai/webhooks.update \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "id": "don:integration:dvrv-us-1:devo/example:webhook/webhook-id" 6 }'

1 { 2 "webhook": { 3 "id": "foo", 4 "secret": "foo", 5 "status": "active", 6 "url": "foo", 7 "created_by": { 8 "display_id": "foo", 9 "id": "foo", 10 "display_name": "foo", 11 "display_picture": { 12 "display_id": "foo", 13 "id": "foo", 14 "file": { 15 "type": "foo", 16 "name": "foo", 17 "size": 42 18 } 19 }, 20 "email": "foo", 21 "full_name": "foo", 22 "state": "active" 23 }, 24 "created_date": "2023-01-01T12:00:00.000Z", 25 "display_id": "foo", 26 "event_types": [ 27 "account_created" 28 ], 29 "modified_by": { 30 "display_id": "foo", 31 "id": "foo", 32 "display_name": "foo", 33 "display_picture": { 34 "display_id": "foo", 35 "id": "foo", 36 "file": { 37 "type": "foo", 38 "name": "foo", 39 "size": 42 40 } 41 }, 42 "email": "foo", 43 "full_name": "foo", 44 "state": "active" 45 }, 46 "modified_date": "2023-01-01T12:00:00.000Z" 47 } 48 }

1	curl -X POST https://api.devrev.ai/webhooks.update \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"id": "don:integration:dvrv-us-1:devo/example:webhook/webhook-id"
6	}'

1	{
2	"webhook": {
3	"id": "foo",
4	"secret": "foo",
5	"status": "active",
6	"url": "foo",
7	"created_by": {
8	"display_id": "foo",
9	"id": "foo",
10	"display_name": "foo",
11	"display_picture": {
12	"display_id": "foo",
13	"id": "foo",
14	"file": {
15	"type": "foo",
16	"name": "foo",
17	"size": 42
18	}
19	},
20	"email": "foo",
21	"full_name": "foo",
22	"state": "active"
23	},
24	"created_date": "2023-01-01T12:00:00.000Z",
25	"display_id": "foo",
26	"event_types": [
27	"account_created"
28	],
29	"modified_by": {
30	"display_id": "foo",
31	"id": "foo",
32	"display_name": "foo",
33	"display_picture": {
34	"display_id": "foo",
35	"id": "foo",
36	"file": {
37	"type": "foo",
38	"name": "foo",
39	"size": 42
40	}
41	},
42	"email": "foo",
43	"full_name": "foo",
44	"state": "active"
45	},
46	"modified_date": "2023-01-01T12:00:00.000Z"
47	}
48	}