List webhook endpoints

GET

/webhooks/endpoints

GET

/api/v1/webhooks/endpoints

$ curl https://tryenvoy.ai/api/v1/webhooks/endpoints \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "data": [
3     {
4       "id": "ep_3f9a1c2b-7d4e-4f8a-9b2d-1a2b3c4d5e6f",
5       "organization_id": "org_8a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
6       "url": "https://webhooks.example.com/receive",
7       "description": "Primary webhook endpoint for shipment updates",
8       "event_types": [
9         "shipment.created",
10         "shipment.updated",
11         "shipment.delivered"
12       ],
13       "headers": {
14         "Authorization": "Bearer abcdef1234567890",
15         "Content-Type": "application/json"
16       },
17       "status": "ACTIVE",
18       "disabled_reason": null,
19       "created_at": "2024-01-15T09:30:00Z",
20       "updated_at": "2024-04-10T14:45:00Z"
21     }
22   ],
23   "pagination": {
24     "page": 1,
25     "page_size": 1,
26     "total_count": 5,
27     "total_pages": 5,
28     "has_next": true,
29     "has_prev": false
30   }
31 }

Paginated list of webhook endpoints registered for your organization.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

Response

Successful Response

datalist of objects

List of items for the current page

paginationobject

Pagination metadata

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

429

Too Many Requests Error

Authentication

Headers

Query parameters

Response

Errors