Developer: Developer

Base URL: $BUSINESS_API

Get developer overview

Logs

GET /developer/overview

Requests, error rate, latency and webhook success over a window

Summarizes the tenant's API traffic and webhook deliveries over a window given by from and to (RFC 3339), which defaults to the last 24 hours and may span at most 90 days. Request statistics are bucketed hourly, or daily when the window exceeds 48 hours; the response also counts active API keys, enabled webhooks and request logs dropped under load. Requires developer:read; a malformed timestamp or an invalid window returns 400.

Parameters

fromstring · query · optional

RFC 3339 start; defaults to 24 hours before to

tostring · query · optional

RFC 3339 end; defaults to now

Returns

200 Overview

Show attributes
fromstring (date-time) · optional
tostring (date-time) · optional
bucket_secondsinteger · optional
active_api_keysinteger · optional
enabled_webhooksinteger · optional
requestsobject · optional
Show child attributes
totalinteger · optional
client_errorsinteger · optional
server_errorsinteger · optional
error_ratenumber · optional
p50_msinteger · optional
p95_msinteger · optional
seriesarray of object · optional
Show child attributes
startstring (date-time) · optional
requestsinteger · optional
errorsinteger · optional
webhooksobject · optional
Show child attributes
totalinteger · optional
succeededinteger · optional
failedinteger · optional
pendinginteger · optional
success_ratenumber · optional

Errors 400 · 401 · 403

Permissions developer:read · Roles: admin, owner

curl -X GET "$BUSINESS_API/developer/overview" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "from": "2026-11-19T09:30:00Z",
  "to": "2026-11-19T09:30:00Z",
  "bucket_seconds": 1,
  "active_api_keys": 1,
  "enabled_webhooks": 1,
  "requests": {
    "total": 125000,
    "client_errors": 1,
    "server_errors": 1,
    "error_rate": 1,
    "p50_ms": 1,
    "p95_ms": 1,
    "series": [
      {
        "start": "2026-11-19T09:30:00Z",
        "requests": 1,
        "errors": 1
      }
    ]
  },
  "webhooks": {
    "total": 125000,
    "succeeded": 1,
    "failed": 1,
    "pending": 1,
    "success_rate": 1
  }
}

Scopes the caller can put on an API key

Logs

GET /developer/scopes

Returns the scopes the caller can put on a restricted API key in the current context: the catalog of grantable scopes narrowed to those the caller holds. A secret key created now would carry this same list. Requires developer:read.

Returns

200 Grantable scopes

Show attributes
dataarray of string · optional

Errors 400 · 401 · 403

Permissions developer:read · Roles: admin, owner

curl -X GET "$BUSINESS_API/developer/scopes" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    "data"
  ]
}

Webhook event type catalog

Logs

GET /developer/event-types

Returns the catalog of event types a webhook endpoint can subscribe to, each with its type name, category and description. Use these names (or * for every event) in a webhook's events list. Requires developer:read.

Returns

200 Event types

Show attributes
dataarray of object · optional
Show child attributes
typestring · optional
categorystring · optional
descriptionstring · optional

Errors 400 · 401 · 403

Permissions developer:read · Roles: admin, owner

curl -X GET "$BUSINESS_API/developer/event-types" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "type": "active",
      "category": "category",
      "description": "Leitura confirmada no local."
    }
  ]
}

Get a delivery with its payload and attempts

Logs

GET /developer/deliveries/{id}

Returns one webhook delivery with its status, the event payload it carries and the history of every attempt (response status, error, response body and duration), oldest first. Requires developer:read; an unknown delivery returns 404. The same operation is also served at /developer/webhooks/deliveries/{id}.

Parameters

idstring · path · required

Identifier of the webhook delivery in the authenticated tenant.

Returns

200 Delivery

Show attributes
idstring · optional
webhook_idstring · optional
urlstring · optional
event_idstring · optional
event_typestring · optional
statusstring · optional

one of pending, delivering, succeeded, failed, cancelled, paused

attemptsinteger · optional
max_attemptsinteger · optional
next_attempt_atstring (date-time) · optional
response_statusinteger · optional
last_errorstring · optional
duration_msinteger · optional
created_atstring (date-time) · optional
completed_atstring (date-time) · optional
payloadstring · optional

JSON event body; on the detail read

historyarray of object · optional
Show child attributes
attemptinteger · optional
response_statusinteger · optional
errorstring · optional
response_bodystring · optional
duration_msinteger · optional
occurred_atstring (date-time) · optional

Errors 400 · 401 · 403

Permissions developer:read · Roles: admin, owner

curl -X GET "$BUSINESS_API/developer/deliveries/{id}" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "dev_2xrGunF2qj9uI97qEnJQArJ0Qd5",
  "webhook_id": "whk_2Fhestrmgp5E6phyoldkw1BQmj3",
  "url": "https://example.org/",
  "event_id": "eve_2yU5ru85900HFyKpvIKdHuq7NSO",
  "event_type": "event type",
  "status": "pending",
  "attempts": 1,
  "max_attempts": 1,
  "next_attempt_at": "2026-11-19T09:30:00Z",
  "response_status": 1,
  "last_error": "last error",
  "duration_ms": 1,
  "created_at": "2026-11-19T09:30:00Z",
  "completed_at": "2026-11-19T09:30:00Z",
  "payload": "payload",
  "history": [
    {
      "attempt": 1,
      "response_status": 1,
      "error": "error",
      "response_body": "response body",
      "duration_ms": 1,
      "occurred_at": "2026-11-19T09:30:00Z"
    }
  ]
}

Make a delivery due now

Logs

POST /developer/deliveries/{id}/retry

Resets a delivery to pending, makes it due now with a fresh attempt budget and wakes the delivery worker; the response is 202 with the updated delivery. Ordering per resource still applies, so it can wait behind an earlier undelivered event about the same resource. Requires developer:write; 409 is returned when the delivery is being attempted right now or its webhook no longer exists, and 404 when the delivery is unknown.

Parameters

idstring · path · required

Identifier of the webhook delivery to retry.

Returns

202 Delivery

Show attributes
idstring · optional
webhook_idstring · optional
urlstring · optional
event_idstring · optional
event_typestring · optional
statusstring · optional

one of pending, delivering, succeeded, failed, cancelled, paused

attemptsinteger · optional
max_attemptsinteger · optional
next_attempt_atstring (date-time) · optional
response_statusinteger · optional
last_errorstring · optional
duration_msinteger · optional
created_atstring (date-time) · optional
completed_atstring (date-time) · optional
payloadstring · optional

JSON event body; on the detail read

historyarray of object · optional
Show child attributes
attemptinteger · optional
response_statusinteger · optional
errorstring · optional
response_bodystring · optional
duration_msinteger · optional
occurred_atstring (date-time) · optional

Errors 400 · 401 · 403

Permissions developer:write · Roles: admin, owner

curl -X POST "$BUSINESS_API/developer/deliveries/{id}/retry" \
  -H "Authorization: Bearer sk_test_..."
Response 202
{
  "id": "dev_2xrGunF2qj9uI97qEnJQArJ0Qd5",
  "webhook_id": "whk_2Fhestrmgp5E6phyoldkw1BQmj3",
  "url": "https://example.org/",
  "event_id": "eve_2yU5ru85900HFyKpvIKdHuq7NSO",
  "event_type": "event type",
  "status": "pending",
  "attempts": 1,
  "max_attempts": 1,
  "next_attempt_at": "2026-11-19T09:30:00Z",
  "response_status": 1,
  "last_error": "last error",
  "duration_ms": 1,
  "created_at": "2026-11-19T09:30:00Z",
  "completed_at": "2026-11-19T09:30:00Z",
  "payload": "payload",
  "history": [
    {
      "attempt": 1,
      "response_status": 1,
      "error": "error",
      "response_body": "response body",
      "duration_ms": 1,
      "occurred_at": "2026-11-19T09:30:00Z"
    }
  ]
}

List business API requests

Logs

GET /developer/logs

Returns logged business API requests for the tenant, one cursor page at a time, without request or response bodies. By default only requests made with API keys are listed; pass principal_type, or include_sessions=true, to see other traffic. Filters: status is a class such as 4xx, method matches case-insensitively, path is a prefix, key matches an API key ID or prefix, request_id matches exactly, and from and to are RFC 3339 timestamps. Requires developer:read; an invalid status class or timestamp returns 400.

Parameters

statusstring · query · optional

Status class: 2xx, 4xx, 5xx ...

methodstring · query · optional

HTTP method

pathstring · query · optional

Path prefix

keystring · query · optional

API key id or prefix

request_idstring · query · optional

Exact request id, as returned in X-Request-Id and in error responses

fromstring · query · optional

RFC 3339 start

tostring · query · optional

RFC 3339 end

limitinteger · query · optional

Maximum resources to return (default 20, maximum 100).

afterstring · query · optional

Opaque cursor returned by the previous page.

Returns

200 Request logs

Show attributes
dataarray of DeveloperRequestLog · optional
Show child attributes
idstring · optional
methodstring · optional
pathstring · optional
statusinteger · optional
duration_msinteger · optional
principal_idstring · optional
principal_typestring · optional
api_key_idstring · optional
api_key_prefixstring · optional
request_idstring · optional
ipstring · optional
occurred_atstring (date-time) · optional
request_bodystring · optional

Redacted; on the detail read

response_bodystring · optional

Redacted; on the detail read

has_moreboolean · optional
next_cursorstring · optional

Errors 400 · 401 · 403

Permissions developer:read · Roles: admin, owner

curl -X GET "$BUSINESS_API/developer/logs" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "id": "dev_2rbgcbZyMXBUw5hMYBJwGtD6GRB",
      "method": "method",
      "path": "path",
      "status": 1,
      "duration_ms": 1,
      "principal_id": "pri_2E8NTQWZ96sxLuEdX2GL5mAJjEY",
      "principal_type": "principal type",
      "api_key_id": "api_28mJj6K75G8Pzm21FocD12wvnI0",
      "api_key_prefix": "api key prefix",
      "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
      "ip": "ip",
      "occurred_at": "2026-11-19T09:30:00Z",
      "request_body": "request body",
      "response_body": "response body"
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor"
}

Get a request log with redacted bodies

Logs

GET /developer/logs/{id}

Returns one logged request with its method, path, status, duration, caller and API key, and request and response bodies with sensitive fields redacted. Requires developer:read; an unknown log returns 404.

Parameters

idstring · path · required

Identifier of the request log entry in the authenticated tenant.

Returns

200 Request log

Show attributes
idstring · optional
methodstring · optional
pathstring · optional
statusinteger · optional
duration_msinteger · optional
principal_idstring · optional
principal_typestring · optional
api_key_idstring · optional
api_key_prefixstring · optional
request_idstring · optional
ipstring · optional
occurred_atstring (date-time) · optional
request_bodystring · optional

Redacted; on the detail read

response_bodystring · optional

Redacted; on the detail read

Errors 400 · 401 · 403

Permissions developer:read · Roles: admin, owner

curl -X GET "$BUSINESS_API/developer/logs/{id}" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "dev_2rbgcbZyMXBUw5hMYBJwGtD6GRB",
  "method": "method",
  "path": "path",
  "status": 1,
  "duration_ms": 1,
  "principal_id": "pri_2E8NTQWZ96sxLuEdX2GL5mAJjEY",
  "principal_type": "principal type",
  "api_key_id": "api_28mJj6K75G8Pzm21FocD12wvnI0",
  "api_key_prefix": "api key prefix",
  "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
  "ip": "ip",
  "occurred_at": "2026-11-19T09:30:00Z",
  "request_body": "request body",
  "response_body": "response body"
}

List published domain events

Logs

GET /developer/events

Returns the domain events published for the tenant, one cursor page at a time, without their payloads; fetch one event to see its payload. Filters: type, resource_type and resource_id match exactly, and from and to are RFC 3339 timestamps bounding the creation time. Each event states when it stops being available for replay. Requires developer:read; a malformed timestamp returns 400.

Parameters

typestring · query · optional

Event type

resource_typestring · query · optional

Resource type

resource_idstring · query · optional

Resource id

fromstring · query · optional

RFC 3339 start

tostring · query · optional

RFC 3339 end

limitinteger · query · optional

Maximum resources to return (default 20, maximum 100).

afterstring · query · optional

Opaque cursor returned by the previous page.

Returns

200 Events

Show attributes
dataarray of DeveloperEvent · optional
Show child attributes
idstring · optional
tenant_idstring · optional
typestring · optional
resource_typestring · optional
resource_idstring · optional
payloadstring · optional

Signed JSON body; on the detail read

created_atstring (date-time) · optional
deliveriesarray of DeveloperDelivery · optional
Show child attributes
idstring · optional
webhook_idstring · optional
urlstring · optional
event_idstring · optional
event_typestring · optional
statusstring · optional

one of pending, delivering, succeeded, failed, cancelled, paused

attemptsinteger · optional
max_attemptsinteger · optional
next_attempt_atstring (date-time) · optional
response_statusinteger · optional
last_errorstring · optional
duration_msinteger · optional
created_atstring (date-time) · optional
completed_atstring (date-time) · optional
payloadstring · optional

JSON event body; on the detail read

historyarray of object · optional
Show child attributes
attemptinteger · optional
response_statusinteger · optional
errorstring · optional
response_bodystring · optional
duration_msinteger · optional
occurred_atstring (date-time) · optional
has_moreboolean · optional
next_cursorstring · optional

Errors 400 · 401 · 403

Permissions developer:read · Roles: admin, owner

curl -X GET "$BUSINESS_API/developer/events" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "id": "dev_2FbUujfGaXxeuNPyMN3CUhHI8zh",
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "type": "active",
      "resource_type": "resource type",
      "resource_id": "res_2iAXhMsJzmqPnY6X5cMTJ6OBTSG",
      "payload": "payload",
      "created_at": "2026-11-19T09:30:00Z",
      "deliveries": [
        {
          "id": "dev_2xrGunF2qj9uI97qEnJQArJ0Qd5",
          "webhook_id": "whk_2Fhestrmgp5E6phyoldkw1BQmj3",
          "url": "https://example.org/",
          "event_id": "eve_2yU5ru85900HFyKpvIKdHuq7NSO",
          "event_type": "event type",
          "status": "pending",
          "attempts": 1,
          "max_attempts": 1,
          "next_attempt_at": "2026-11-19T09:30:00Z",
          "response_status": 1,
          "last_error": "last error",
          "duration_ms": 1,
          "created_at": "2026-11-19T09:30:00Z",
          "completed_at": "2026-11-19T09:30:00Z",
          "payload": "payload",
          "history": [
            {}
          ]
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor"
}

Get an event with its payload and deliveries

Logs

GET /developer/events/{id}

Returns one published event with its full payload and every webhook delivery created for it, plus when it stops being available for replay. Requires developer:read; an unknown event returns 404.

Parameters

idstring · path · required

Identifier of the published event in the authenticated tenant.

Returns

200 Event

Show attributes
idstring · optional
tenant_idstring · optional
typestring · optional
resource_typestring · optional
resource_idstring · optional
payloadstring · optional

Signed JSON body; on the detail read

created_atstring (date-time) · optional
deliveriesarray of DeveloperDelivery · optional
Show child attributes
idstring · optional
webhook_idstring · optional
urlstring · optional
event_idstring · optional
event_typestring · optional
statusstring · optional

one of pending, delivering, succeeded, failed, cancelled, paused

attemptsinteger · optional
max_attemptsinteger · optional
next_attempt_atstring (date-time) · optional
response_statusinteger · optional
last_errorstring · optional
duration_msinteger · optional
created_atstring (date-time) · optional
completed_atstring (date-time) · optional
payloadstring · optional

JSON event body; on the detail read

historyarray of object · optional
Show child attributes
attemptinteger · optional
response_statusinteger · optional
errorstring · optional
response_bodystring · optional
duration_msinteger · optional
occurred_atstring (date-time) · optional

Errors 400 · 401 · 403

Permissions developer:read · Roles: admin, owner

curl -X GET "$BUSINESS_API/developer/events/{id}" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "dev_2FbUujfGaXxeuNPyMN3CUhHI8zh",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "type": "active",
  "resource_type": "resource type",
  "resource_id": "res_2iAXhMsJzmqPnY6X5cMTJ6OBTSG",
  "payload": "payload",
  "created_at": "2026-11-19T09:30:00Z",
  "deliveries": [
    {
      "id": "dev_2xrGunF2qj9uI97qEnJQArJ0Qd5",
      "webhook_id": "whk_2Fhestrmgp5E6phyoldkw1BQmj3",
      "url": "https://example.org/",
      "event_id": "eve_2yU5ru85900HFyKpvIKdHuq7NSO",
      "event_type": "event type",
      "status": "pending",
      "attempts": 1,
      "max_attempts": 1,
      "next_attempt_at": "2026-11-19T09:30:00Z",
      "response_status": 1,
      "last_error": "last error",
      "duration_ms": 1,
      "created_at": "2026-11-19T09:30:00Z",
      "completed_at": "2026-11-19T09:30:00Z",
      "payload": "payload",
      "history": [
        {
          "attempt": 1,
          "response_status": 1,
          "error": "error",
          "response_body": "response body",
          "duration_ms": 1,
          "occurred_at": "2026-11-19T09:30:00Z"
        }
      ]
    }
  ]
}