Create

POST

Creates a new webhook target.

Request

This endpoint expects an object.

urlstringRequired

The URL of the webhook endpoint.

event_typeslist of enumsOptional

The event types that the webhook endpoint will receive.

secretstringOptional

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

This endpoint returns an object.

webhookobject

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": "url"
6 }'

200Successful

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

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": "url"
6	}'

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