v2

latestOpenAPI 3.1.02026-07-312303692.4 MB

Endpoint

Patch Endpoint

Partially update an endpoint.

patch/api/v1/app/{app_id}/endpoint/{endpoint_id}

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

The Endpoint's ID or UID.

Request body

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

The Endpoint's UID.

urlstring uri

versioninteger

disabledboolean

filterTypesstring[] nullable

channelsstring[] nullable

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

Example request

{
  "uid": "unique-identifier",
  "version": 1,
  "filterTypes": [
    "user.signup"
  ],
  "channels": [
    "project_1337"
  ],
  "secret": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"
}

Response

idstring required

The Endpoint's ID.

metadataobject required

urlstring uri required

descriptionstring required

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 required

disabledboolean

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",
  "url": "https://example.com/webhook/",
  "uid": "unique-identifier",
  "version": 1,
  "filterTypes": [
    "user.signup",
    "user.deleted"
  ],
  "channels": [
    "project_123",
    "group_2"
  ]
}