Create Webhook

POST

Creates a new webhook target.

Request

This endpoint expects an object.

urlstringRequiredformat: "text"

The URL of the webhook endpoint.

event_typeslist of enumsOptional

The event types that the webhook endpoint will receive.

secretstringOptionalformat: "byte"

The secret to use when verifying webhook events. If provided, the secret must be between 8 and 32 bytes (inclusive). If not set, a secret will be automatically generated and provided in the response.

Response

The response to creating a new webhook.

webhookobject

Errors

POST

1 curl -X POST https://api.devrev.ai/webhooks.create \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "url": "foo"
6 }'

201webhooksCreateExample

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 }

Delete Webhook

Up Next

Built with

1	curl -X POST https://api.devrev.ai/webhooks.create \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"url": "foo"
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	}