Sign in
Ingest Endpoint

Get Ingest Endpoint

Get an ingest endpoint.

get/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}

Path parameters

source_idstring required

The Source's ID or UID.

Example:unique-identifier

The Source's ID or UID.

endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

The Endpoint's ID or UID.

Response

createdAtstring date-time required
descriptionstring required
disabledboolean
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

{
  "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "uid": "unique-identifier",
  "url": "https://example.com/webhook/"
}

Changes

Changed in 1 of the 5 revisions of this API.1

  • dc130bd1b0741See the full diff
    • ●

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

      response-optional-property-removed

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