List sandbox webhooks

GET/api/v1/sandbox/webhooks
Requires anorganization API keywith the scopesandbox:read

Sandbox webhooks are separate from your live webhooks: a live webhook never receives a sandbox event and a sandbox webhook never receives a live one. The payload is the same format as live, plus environment: "sandbox", sandbox_inbox_id and an X-Webhook-Environment: sandbox header, so your handler needs no changes and can still tell them apart.

Parameters

NameInTypeDescription
inbox_idquerystringOnly webhooks for this inbox.

Request

GET/api/v1/sandbox/webhooks
curl -X GET 'https://app.mailyte.com/api/v1/sandbox/webhooks' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

  • dataobject
    • itemsarray<object>
      • idstring
      • organization_idstring
      • inbox_idstring

        The inbox whose messages fire it. Null means every inbox in the organization.

      • urlstring
      • eventsarray<string>
      • statusstringactive | disabled
      • created_atstring

        When it was created.

      • updated_atstring

        When it was last changed.

    • totalinteger

      Matching rows in all, not just this page.

Returned inside the standard envelope.

Errors

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.