Sign in
Ingest Endpoint

Create Ingest Endpoint

Create an ingest endpoint.

post/ingest/api/v1/source/{source_id}/endpoint

Path parameters

source_idstring required

The Source's ID or UID.

Example:unique-identifier

The Source's ID or UID.

Headers

idempotency-keystring

The request's idempotency key

Request body

descriptionstring
disabledboolean
headersobject nullable
metadataobject
secretstring nullable

The endpoint's verification secret.

Format: base64 encoded random bytes optionally prefixed with whsec_. It is recommended to not set this and let the server generate the secret.

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

{
  "description": "An example endpoint name",
  "headers": {
    "X-Example": "123",
    "X-Foobar": "Bar"
  },
  "secret": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD",
  "uid": "unique-identifier",
  "url": "https://example.com/webhook/"
}

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.21

  • dc130bd1b07421See the full diff
    • ●

      removed the request property rateLimit

      request-property-removed

    • ●

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

      response-optional-property-removed

    • ○

      added the new optional request property headers

      new-optional-request-property

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