Get a webhook endpoint

Authentication: Supports API key and bearer token authentication.

AuthorizationBearer

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

endpoint_idstringRequiredformat: "uuid"

Successful Response

idstringformat: "^ep_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

organization_idstringformat: "^org_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

urlstring

descriptionstring or null

event_typeslist of strings

headersmap from strings to strings or null

statusenum

Endpoint lifecycle state.

DISABLED is reserved for automatic disable by the auto-disable job; PAUSED is explicitly paused and indicates intent to resume.

disabled_reasonstring or null

created_atdatetime

updated_atdatetime

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

1	{
2	"id": "ep_3f9a1c2b-7d4e-4f8a-9b2d-1a2c3e4f5b6d",
3	"organization_id": "org_8b7c6d5e-4f3a-2b1c-0d9e-8f7a6b5c4d3e",
4	"url": "https://webhooks.example.com/notify",
5	"description": "Webhook endpoint for shipment status updates",
6	"event_types": [
7	"shipment.created",
8	"shipment.updated",
9	"shipment.delivered"
10	],
11	"headers": {
12	"Authorization": "Bearer abcdef1234567890",
13	"Content-Type": "application/json"
14	},
15	"status": "ACTIVE",
16	"disabled_reason": null,
17	"created_at": "2024-01-15T09:30:00Z",
18	"updated_at": "2024-01-15T09:30:00Z"
19	}

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