v2

latestOpenAPI 3.1.02026-07-312303692.4 MB

Endpoint

Create Endpoint

Create a new endpoint for the application.

When secret is null the secret is automatically generated (recommended).

post/api/v1/app/{app_id}/endpoint

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

Headers

idempotency-keystring

The request's idempotency key

Request body

urlstring uri required

descriptionstring

rateLimitinteger nullable

Deprecated, use throttleRate instead.

throttleRateinteger nullable

Maximum messages per second to send to this endpoint.

Outgoing messages will be throttled to this rate.

uidstring nullable

Optional unique identifier for the endpoint.

versioninteger nullable

disabledboolean

filterTypesstring[] nullable

channelsstring[] nullable

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

secretstring nullable

The endpoint's verification secret.

Format: base64 encoded random bytes optionally prefixed with whsec_. It is recommended to not set this and let the server generate the secret.

metadataobject

headersobject nullable

Example request

{
  "url": "https://example.com/webhook/",
  "description": "An example endpoint name",
  "uid": "unique-identifier",
  "version": 1,
  "filterTypes": [
    "user.signup",
    "user.deleted"
  ],
  "channels": [
    "project_123",
    "group_2"
  ],
  "secret": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD",
  "headers": {
    "X-Example": "123",
    "X-Foobar": "Bar"
  }
}

Response

idstring required

The Endpoint's ID.

metadataobject required