Create Webhook

Create a webhook endpoint.

The response includes the endpoint's signing secret. It is shown only once, so store it before you continue. A team can have at most 50 webhook endpoints, and each URL can be registered once per team: repeating a create request for the same URL returns a validation error instead of a second endpoint.

Authorization

api_key

x-access-token<token>

In: header

Request Body

application/json

The endpoint to create

url*string

Public HTTPS URL that receives deliveries. Each URL can be registered once per team. Private, loopback, link-local and metadata destinations are rejected.

description?string

Optional note to tell endpoints apart

event_patterns*array<string>

Topics to deliver: an exact topic such as orders/created, every topic of a resource such as fulfillments/*, or * for all topics. At least one is required. Topics are listed at https://support.cybership.io/docs/shipos/api/webhooks/list-of-topics

active*boolean

true starts deliveries right away. false creates the endpoint paused.

headers?

Extra HTTP headers sent with every delivery, such as a token your receiver checks. Header values are stored encrypted and are never returned by the API.

At most 32 headers.
Names must be HTTP tokens. They are compared case-insensitively and stored in lowercase, so X-Token and x-token together are a duplicate.
Values can have up to 4096 Latin-1 characters and can't contain CR, LF or NUL.
These names are reserved and refused: host, content-length, content-type, connection, transfer-encoding, upgrade, expect, proxy-authorization, proxy-connection, te, trailer, and any name that starts with x-cybr-.

contact_email*string

Address that is emailed when deliveries to this endpoint stop after repeated failures

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/shipos/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "string",    "event_patterns": [      "string"    ],    "active": true,    "contact_email": "string"  }'

{  "id": "string",  "url": "string",  "description": "string",  "contact_email": "string",  "paused": true,  "active": true,  "status": "active",  "event_patterns": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "health": {    "consecutive_failures": 0.1,    "last_successful_at": "2019-08-24T14:15:22Z"  },  "circuit": {    "opened_at": "2019-08-24T14:15:22Z",    "reason": "string",    "probe_at": "2019-08-24T14:15:22Z"  },  "supported_actions": [    {      "action": "VIEW_LOGS"    }  ],  "last_delivery": {    "event_type": "string",    "status": "PENDING",    "delivered_at": "2019-08-24T14:15:22Z"  },  "secret": "string"}

Authorization

Request Body

Response Body

201application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

429application/problem+json

500application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`