Sign in
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

channelsstring[] nullable
descriptionstring
disabledboolean
eventTypesstring[] nullable
metadataobject
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

Example request

{
  "channels": [
    "project_1337"
  ],
  "eventTypes": [
    "user.signup"
  ],
  "uid": "unique-identifier"
}

Response

channelsstring[] nullable

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

createdAtstring date-time required
descriptionstring required
disabledboolean
eventTypesstring[] nullable
idstring required

The Endpoint's ID.

metadataobject required
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.

updatedAtstring date-time required
urlstring uri required

Example response

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

Changes

Changed in 2 of the 5 revisions of this API.164

  • dc130bd1b074162See the full diff
    • ▲

      removed the required property version from the response with the 200 status

      response-required-property-removed

    • ●

      removed the request property filterTypes

      request-property-removed

    • ●

      removed the request property rateLimit

      request-property-removed

    • ●

      removed the request property secret

      request-property-removed

    • ●

      removed the request property version

      request-property-removed

    • ●

      removed the optional property filterTypes from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property rateLimit from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional request property eventTypes

      new-optional-request-property

    • ○

      added the optional property eventTypes to the response with the 200 status

      response-optional-property-added

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 16dbcc056c482See the full diff
    • ○

      added the new optional request property secret

      new-optional-request-property

    • ○

      added the new optional request property version

      new-optional-request-property

    This revision also has 157 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog