v2

latestOpenAPI 3.1.02026-07-312303692.4 MB

Endpoint

Upsert Endpoint

Create or update an endpoint.

put/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

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).

metadataobject

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"
  ]
}

Response

idstring required

The Endpoint's ID.

metadataobject required