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

List subscribable event types

GET
/webhooks/event-types
GET
/api/v1/webhooks/event-types
$curl https://tryenvoy.ai/api/v1/webhooks/event-types \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1[
2  {
3    "name": "shipment.created",
4    "description": "Fires when a new shipment is created in the system.",
5    "payload_schema": {
6      "type": "object",
7      "properties": {
8        "shipment_id": {
9          "type": "string",
10          "description": "Unique identifier for the shipment",
11          "example": "shp_1234567890abcdef"
12        },
13        "origin": {
14          "type": "string",
15          "description": "Origin location code",
16          "example": "LAX"
17        },
18        "destination": {
19          "type": "string",
20          "description": "Destination location code",
21          "example": "JFK"
22        },
23        "created_at": {
24          "type": "string",
25          "format": "date-time",
26          "description": "Timestamp when the shipment was created",
27          "example": "2024-06-01T12:00:00Z"
28        },
29        "status": {
30          "type": "string",
31          "description": "Current status of the shipment",
32          "enum": [
33            "pending",
34            "in_transit",
35            "delivered",
36            "cancelled"
37          ],
38          "example": "pending"
39        }
40      },
41      "required": [
42        "shipment_id",
43        "origin",
44        "destination",
45        "created_at",
46        "status"
47      ]
48    }
49  },
50  {
51    "name": "shipment.delivered",
52    "description": "Fires when a shipment has been successfully delivered.",
53    "payload_schema": {
54      "type": "object",
55      "properties": {
56        "shipment_id": {
57          "type": "string",
58          "description": "Unique identifier for the shipment",
59          "example": "shp_1234567890abcdef"
60        },
61        "delivered_at": {
62          "type": "string",
63          "format": "date-time",
64          "description": "Timestamp when the shipment was delivered",
65          "example": "2024-06-05T15:30:00Z"
66        },
67        "receiver_name": {
68          "type": "string",
69          "description": "Name of the person who received the shipment",
70          "example": "John Doe"
71        },
72        "condition": {
73          "type": "string",
74          "description": "Condition of the shipment upon delivery",
75          "enum": [
76            "intact",
77            "damaged",
78            "missing_items"
79          ],
80          "example": "intact"
81        }
82      },
83      "required": [
84        "shipment_id",
85        "delivered_at",
86        "receiver_name",
87        "condition"
88      ]
89    }
90  },
91  {
92    "name": "invoice.paid",
93    "description": "Fires when an invoice has been paid successfully.",
94    "payload_schema": {
95      "type": "object",
96      "properties": {
97        "invoice_id": {
98          "type": "string",
99          "description": "Unique identifier for the invoice",
100          "example": "inv_9876543210fedcba"
101        },
102        "amount": {
103          "type": "number",
104          "format": "float",
105          "description": "Amount paid",
106          "example": 1250.75
107        },
108        "currency": {
109          "type": "string",
110          "description": "Currency code",
111          "example": "USD"
112        },
113        "paid_at": {
114          "type": "string",
115          "format": "date-time",
116          "description": "Timestamp when the payment was made",
117          "example": "2024-06-03T09:45:00Z"
118        },
119        "payment_method": {
120          "type": "string",
121          "description": "Method used for payment",
122          "enum": [
123            "credit_card",
124            "bank_transfer",
125            "paypal"
126          ],
127          "example": "credit_card"
128        }
129      },
130      "required": [
131        "invoice_id",
132        "amount",
133        "currency",
134        "paid_at",
135        "payment_method"
136      ]
137    }
138  }
139]
Catalog of event type names you can pass in `event_types` when registering an endpoint. Each entry includes a JSON Schema for the envelope's `data` field — use it to generate types or validate incoming payloads. Trigger the event in the platform to see a real delivery in the endpoint's log. **Authentication:** Supports API key and bearer token authentication.
Was this page helpful?
Previous
Built with

Catalog of event type names you can pass in event_types when registering an endpoint. Each entry includes a JSON Schema for the envelope’s data field — use it to generate types or validate incoming payloads. Trigger the event in the platform to see a real delivery in the endpoint’s log.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

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

Headers

X-Organization-IDstring or nullOptional

Response

Successful Response
namestring

Event type identifier, e.g. ‘elp_test.scored’

descriptionstring

Human-readable summary of when this event fires.

payload_schemamap from strings to any

JSON Schema describing the envelope’s data field for this event.

Errors

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