Webhook Endpoints API

The team's endpoints without their secrets.

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

201 with the resource and a top-level secret.

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.

With reason: missing_team_scope when the token carries no team scope.

The key was already used in the last 24 hours with a different request body.

The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with error.message saying why and no fields. On this endpoint: VALIDATION_FAILED: when url is not https://, points at a private or reserved host, or exceeds 2,048 characters; when events is empty or names an unknown event; when allowed_ips holds an invalid address or range; when name is outside 3 to 100 characters.

The first request with this key is still running; retry in a few seconds and the original response is replayed.

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

The endpoint and its delivery health, without its secret.

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

No content

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description. On this endpoint: FORBIDDEN: when the caller neither registered the endpoint nor owns the team.

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.

The key was already used in the last 24 hours with a different request body.

The first request with this key is still running; retry in a few seconds and the original response is replayed.

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

The resource with the new plaintext secret, once.

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description. On this endpoint: FORBIDDEN: when the caller neither registered the endpoint nor owns the team.

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.

The key was already used in the last 24 hours with a different request body.

The first request with this key is still running; retry in a few seconds and the original response is replayed.

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

202 with the new delivery's id and status.

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description. On this endpoint: FORBIDDEN: when the caller neither registered the endpoint nor owns the team.

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.

The key was already used in the last 24 hours with a different request body.

The first request with this key is still running; retry in a few seconds and the original response is replayed.

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

The endpoint, paused.

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description. On this endpoint: FORBIDDEN: when the caller neither registered the endpoint nor owns the team.

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.

The key was already used in the last 24 hours with a different request body.

The first request with this key is still running; retry in a few seconds and the original response is replayed.

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

The endpoint, active.

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description. On this endpoint: FORBIDDEN: when the caller neither registered the endpoint nor owns the team.

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.

The key was already used in the last 24 hours with a different request body.

The first request with this key is still running; retry in a few seconds and the original response is replayed.

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.