Space SDKs

Destination

A destination’s URL, method, authentication, rate limit, attempts, and health.

A destination in the project: a URL that webhooks are sent to, and how to send them. Its credentials and signing secret are never part of it.

{
  "id": "01m3m5gpbttxs7xnhk0jgyt4wa",
  "projectId": "01m3d44nq41sec9tj8m2tbgh18",
  "name": "Orders, Dar es Salaam",
  "url": "https://orders.example.co.tz/webhooks/payments",
  "urlSecret": false,
  "method": "POST",
  "state": "enabled",
  "auth": { "kind": "bearer" },
  "rateLimit": { "count": 10, "period": "second" },
  "maxAttempts": 10,
  "timeoutSeconds": 15,
  "failing": false,
  "failuresInRow": 0,
  "failingSince": null,
  "createdAt": "2026-09-28T14:08:19.322803Z",
  "updatedAt": "2026-09-28T14:08:19.322803Z"
}

Fields

idstringRequired

The destination’s ID, 26 lowercase letters and digits. A Connection’s destinationId and a Delivery’s destinationId hold this ID.

projectIdstringRequired

The project the destination belongs to.

namestringRequired

1 to 100 characters on one line. Unique in the project.

urlstring | nullRequired

The https URL webhooks are sent to, or null when urlSecret is true.

urlSecretbooleanRequired

Whether the URL is hidden. A hidden URL is still used, and it cannot be read back.

methodstringRequired

POST, PUT, or PATCH, or an empty string to send each webhook with the method it was received with.

statestringRequired

enabled, or paused, when its deliveries wait until it is enabled again.

auth.kindstringRequired

How it authenticates to the URL: none, bearer, basic, or header. The token, password, or header value cannot be read back.

auth.headerstring

Only when kind is header. The name of the header it sends.

rateLimit{ count, period } | nullRequired

At most count sends each period, which is second, minute, or hour. null when there is no limit.

maxAttemptsintegerRequired

How many times each delivery is tried, 1 to 20.

timeoutSecondsintegerRequired

How long each attempt waits for an answer, 1 to 60 seconds.

failingbooleanRequired

true after 3 failed attempts in a row, until an attempt succeeds.

failuresInRowintegerRequired

How many attempts have failed in a row. A success sets it back to 0.

failingSincestring | nullRequired

When the first of the failed attempts in a row happened, as an ISO 8601 date and time, or null when failuresInRow is 0.

createdAtstringRequired

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

updatedAtstringRequired

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

Returned by

Last updated