Connection

A connection’s source, destination, state, filter, delay, and transformation.

A connection in the project: it sends the webhooks one source receives to one destination.

{
  "id": "01m3m5hezf7epksb7f8qbww4wb",
  "projectId": "01m3d44nq41sec9tj8m2tbgh18",
  "sourceId": "01m3m5gpkrvj4qdxwkde3vt4w9",
  "destinationId": "01m3m5gpbttxs7xnhk0jgyt4wa",
  "state": "enabled",
  "filter": { "body": { "status": "COMPLETED", "amount": { "$gte": 1000 } } },
  "delaySeconds": 5,
  "transformation": "function transform(request) {\n  return { headers: {}, body: { orderId: request.body.reference } }\n}",
  "createdAt": "2026-09-28T14:08:19.322803Z",
  "updatedAt": "2026-09-28T14:30:02.104511Z"
}

Fields

idstringRequired

The connection’s ID, 26 lowercase letters and digits. A Delivery’s connectionId holds this ID.

projectIdstringRequired

The project the connection belongs to.

sourceIdstringRequired

The ID of the source it takes webhooks from.

destinationIdstringRequired

The ID of the destination it sends them to.

statestringRequired

enabled, or paused, when it makes no deliveries.

filterRecord<string, unknown> | nullRequired

Which webhooks it takes, or null for every webhook. See Filters.

delaySecondsintegerRequired

How long a delivery waits before its first attempt, 0 to 86,400 seconds.

transformationstring | nullRequired

The JavaScript that changes each webhook before it is sent, or null when there is none. See Transformations.

createdAtstringRequired

When the connection was created, as an ISO 8601 date and time.

updatedAtstringRequired

When the connection last changed, as an ISO 8601 date and time.

Returned by

Last updated