Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Ingest Endpoint

Upsert Ingest Endpoint

Create or update an ingest endpoint.

put/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.

Request body

urlstring uri required
descriptionstring
rateLimitinteger nullable

Deprecated, use throttleRate instead.

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.

disabledboolean
metadataobject

Example request

{
  "url": "https://example.com/webhook/",
  "description": "An example endpoint name",
  "uid": "unique-identifier"
}

Response

idstring required

The Endpoint's ID.

urlstring uri required
descriptionstring required
rateLimitinteger nullable

Deprecated, use throttleRate instead.

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.

disabledboolean
createdAtstring date-time required
updatedAtstring date-time required
metadataobject required

Example response

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