v1

latestOpenAPI 3.1.02026-07-241695611.0 MB

Federation Webhook Management

Patch Federation Webhook Endpoint

patch/federations/{federation_id}/webhooks/{endpoint_id}

Path parameters

federation_idstring uuid required

endpoint_idstring required

Request body

channelsChannel[] nullable

descriptionstring nullable

disabledboolean nullable

filter_typesFilterType[] nullable

metadataobject nullable

rate_limitinteger nullable

secretstring nullable

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

uidstring nullable

The ep's UID

urlstring uri nullable

versioninteger nullable

Example request

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

Response

Successful Response

channelsChannel[] nullable

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

created_atstring date-time required

descriptionstring required

An example endpoint name

disabledboolean nullable

filter_typesFilterType[] nullable

idstring required

The ep's ID

metadataobject required

rate_limitinteger nullable

uidstring nullable

Optional unique identifier for the endpoint

updated_atstring date-time required

urlstring uri required

versioninteger required

Example response

{
  "channels": [
    "project_123",
    "group_2"
  ],
  "filter_types": [
    "user.signup",
    "user.deleted"
  ],
  "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "uid": "unique-ep-identifier",
  "url": "https://example.com/webhook/",
  "version": 1
}