Create webhook
For make shipments using POST at endpoint /v1/webhooks.
Example:
http
POST /v1/webhooks HTTP/1.1
Host: sandbox.tristarexpress.com
Content-Type: application/json
Accept: application/json
Authorization: {{ token }}
{ json }
JSON paramters
| Property | Required | Type | Description |
|---|---|---|---|
| title | Y | String | Name of webhook |
| endpoint | Y | String | Your system endpoint |
| secret | Y | String | Key generated by hash used for validation |
| events | Y | String[] | Lists of events that the webhook will track |
TIP
see the list of events at Events
Complete Example:
Endpoint: /v1/webhooks
http
POST /v1/shipments/1/attachments HTTP/1.1
Host: sandbox.tristarexpress.com
Content-Type: application/json
Accept: application/json
Authorization: {{ token }}
{
"title": "Webhook title",
"endpoint": "https://your-system.com/webhook",
"secret": "secrect",
"events": ["shipment.created", "shipment.status_changed"],
}