v1

latestOpenAPI 3.0.02026-07-2641142112.7 KB

Endpoint

Create Endpoint

Create a new endpoint for the application. Specify the url you wish to receive webhooks and the events you wish to track. When secret is null the secret is automatically generated (recommended)

post/endpoint

Headers

idempotency-keystring

The request's idempotency key

Request body

descriptionstring

Description of your endpoint

rateLimitinteger nullable

Rate limit of your endpoint in messages per second. This is an advanced field. Be aware that setting a low rateLimit can lead to a congestion queue and create delay in webhooks.

uidstring nullable

Optional unique identifier for the endpoint

urlstring uri required

Public url in your services where you plan to receive our messages. If you don't have a public url ready yet, you can use Svix play to test our webhooks https://www.svix.com/play/

disabledboolean

When disabled is true, no messages will be sent to your endpoint. This can be used to deactivate a development or a testing endpoint when not in use.

filterTypesstring[] nullable

channelsstring[] nullable

List of message channels this endpoint listens to (omit for all) This is an advanced field.

secretstring nullable

The endpoint's verification secret. If null is passed (recommanded), a secret is automatically generated. Format: base64 encoded random bytes optionally prefixed with whsec_. Recommended size: 24.

metadataobject

Optional additional properties for your endpoint.

Example request

{
  "description": "Production endpoint",
  "uid": "ep_2k0vWPHlM2MnLgrEhw5oKFfmWMX",
  "url": "https://example.com/webhook/",
  "filterTypes": [
    "shipment.added.to.endpoint",
    "container.new.event.detected"
  ],
  "channels": [
    "project_123",
    "group_2"
  ],
  "secret": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"
}

Response

idstring required

The ep's ID

metadataobject required

Optional additional properties for your endpoint.

descriptionstring required

An example endpoint name

rateLimitinteger nullable

Rate limit of your endpoint in messages per second. This is an advanced field. Be aware that setting a low rateLimit can lead to a congestion queue and create delay in webhooks.

uidstring nullable

Optional unique identifier for the endpoint

urlstring uri required

Public url in your services where you plan to receive our webhooks. If you don't have a public url ready yet, you can use Svix play to test our webhooks https://www.svix.com/play/

versioninteger required

disabledboolean

When disabled is true, no messages will be sent to your endpoint. This can be used to deactivate a development or a testing endpoint when not in use.

filterTypesstring[] nullable

channelsstring[] nullable

List of message channels this endpoint listens to (omit for all)

createdAtstring date-time required

updatedAtstring date-time required

Example response

{
  "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "uid": "unique-ep-identifier",
  "url": "https://example.com/webhook/",
  "version": 1,
  "filterTypes": [
    "shipment.added.to.endpoint",
    "container.new.event.detected"
  ],
  "channels": [
    "project_123",
    "group_2"
  ],
  "createdAt": "2024-01-12T14:43:13.993727Z",
  "updatedAt": "2024-01-12T14:43:13.993727Z"
}