For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDashboard
GuidesAPI Reference
GuidesAPI Reference
  • Endpoints
      • GETTab counts for the loads list
      • GETGet calls for a load
      • GETGet failed carrier verifications for a load
      • GETGet active escalations for a load
      • GETList webhook endpoints
      • POSTRegister a webhook endpoint
      • GETGet a webhook endpoint
      • DELDelete a webhook endpoint
      • PATCHUpdate a webhook endpoint
      • POSTRotate the signing secret
      • GETList delivery attempts for an endpoint
      • GETList attempts for a logical message
      • POSTReplay a delivery
      • GETList subscribable event types
LogoLogo
SupportDashboard
EndpointsAPI

Get a webhook endpoint

GET
/webhooks/endpoints/:endpoint_id
GET
/api/v1/webhooks/endpoints/:endpoint_id
$curl https://tryenvoy.ai/api/v1/webhooks/endpoints/endpoint_id \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
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}

Authentication: Supports API key and bearer token authentication.

Was this page helpful?
Previous

Delete a webhook endpoint

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

endpoint_idstringRequiredformat: "uuid"

Headers

X-Organization-IDstring or nullOptional

Response

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.

Allowed values:
disabled_reasonstring or null
created_atdatetime
updated_atdatetime

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error