SVsvix
Endpoint

Get Endpoint

Changed on

Get an endpoint.

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

Request

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier
endpoint_idstring required

The Endpoint's ID or UID.

Example: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
expirystring date-time nullable

When the endpoint expires, if ever.

No messages are sent to the endpoint after this time.

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