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

channelsstring[] nullable

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

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

Optional unique identifier for the endpoint.

urlstring uri required

Example request

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

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 6 revisions of this API.275

  • dc130bd1b074274See the full diff
    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      api operation id v1.endpoint.update removed and replaced with v1.endpoint.upsert

      api-operation-id-removed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the 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

  • 16dbcc056c481See the full diff
    • ○

      added the new optional request property

      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