Create a sandbox webhook endpoint

POST

POST/payments/organizations/{orgId}/sandbox/webhook-endpoints

curl -s -X POST "$AVVIO_BASE_URL/payments/organizations/$AVVIO_ORG_ID/sandbox/webhook-endpoints" \
  -H "x-api-key: $AVVIO_API_KEY" \
  -H "content-type: application/json" \
  -d '{
        "url": "https://example.com/hooks/avvio"
      }'

const res = await fetch(`${process.env.AVVIO_BASE_URL}/payments/organizations/${process.env.AVVIO_ORG_ID}/sandbox/webhook-endpoints`, {
  method: 'POST',
  headers: {
    'x-api-key': process.env.AVVIO_API_KEY,
    'content-type': 'application/json',
  },
  body: JSON.stringify({
    "url": "https://example.com/hooks/avvio"
  }),
});
console.log(res.status, await res.json());

import os
import requests

res = requests.post(
    f"{os.environ['AVVIO_BASE_URL']}/payments/organizations/{os.environ['AVVIO_ORG_ID']}/sandbox/webhook-endpoints",
    headers={
        "x-api-key": os.environ["AVVIO_API_KEY"],
    },
    json={
        "url": "https://example.com/hooks/avvio"
    },
)
print(res.status_code, res.json())

201Created

{
  "id": "cmf3k2xe80006q8b7d2f4g6hj",
  "url": "https://example.com/hooks/avvio",
  "events": [
    "payout.pending",
    "payout.processing",
    "payout.completed",
    "payout.failed"
  ],
  "secret": "whsec_…",
  "warning": "Store this secret now — it is not retrievable.",
  "createdAt": "2026-08-20T13:58:02.000Z"
}

{
  "type": "BAD_REQUEST",
  "status": 400,
  "detail": "Sandbox webhook endpoints are only available with a test API key (avvio_test_…) or from the sandbox environment in the dashboard.",
  "requestId": "req-ac8",
  "message": "Sandbox webhook endpoints are only available with a test API key (avvio_test_…) or from the sandbox environment in the dashboard.",
  "statusCode": 400
}

{
  "type": "UNAUTHORIZED",
  "status": 401,
  "detail": "Invalid API key",
  "resolution": "Check the API key was copied whole and has not been revoked.",
  "requestId": "req-9bz",
  "message": "Invalid API key",
  "statusCode": 401
}

{
  "type": "DEVELOPER_FEATURE_DISABLED",
  "status": 403,
  "detail": "Developer tools are not enabled for this organization.",
  "requestId": "req-9d4",
  "message": "Developer tools are not enabled for this organization.",
  "statusCode": 403
}

{
  "type": "RATE_LIMITED",
  "status": 429,
  "detail": "ThrottlerException: Too Many Requests",
  "resolution": "Back off and retry after the Retry-After interval.",
  "requestId": "req-9e1",
  "message": "ThrottlerException: Too Many Requests",
  "statusCode": 429
}

Path parameters

orgIdstringRequired
The opaque organization id issued to you, normally CUID-shaped (for example cmsx…). It is not an org_-prefixed alias. Pass it unchanged in every organization-scoped path.

Body

This endpoint expects a JSON object.

urlstring<uri>Required
Publicly reachable HTTPS URL. From your own machine, use a public HTTPS tunnel such as cloudflared or ngrok.
eventsarray of stringOptional
Omit to receive every event type.
Allowed values:payout.pendingpayout.processingpayout.completedpayout.failed
Show 18 more values
payout.returnedpayout.canceledpayout_approval.pendingpayout_approval.approvedpayout_approval.rejectedpayout_approval.expiredpayout_approval.executedpayout_approval.execution_failedpayout_batch.awaiting_confirmationpayout_batch.completedpayout_batch.canceledpayout_batch.failedcheckout_payment.paidcheckout_payment.failedcheckout_payment.refundedcheckout_payment.reversedcheckout_payment.partially_refundeddeposit.completed

Behavior

Test keys only. Register a publicly reachable HTTPS receiver. Use a public HTTPS tunnel (for example cloudflared or ngrok) for webhooks from the sandbox.

Live endpoints are https and are created from the dashboard by a human: a credential able to repoint its own webhook URL could quietly redirect every payout notification, so that stays off the API.

The secret is returned once and is not retrievable afterwards.

The body is validated against the schema below: an unknown event name, or an events that is not an array, answers 400 VALIDATION_ERROR.

Responses

201The endpoint, including its signing secret.

Body

idstringRequired
urlstringRequired
eventsarray of stringRequired
secretstringRequired
Shown once. Store it now.
warningstringRequired
createdAtstring<date-time>Required

Errors

400
BAD_REQUEST: a live key (this is test-only), or no url. UNSAFE_WEBHOOK_DESTINATION: the URL is malformed, carries credentials, or resolves to an address we will not deliver to.
401
The key was refused. Nothing ran.
- UNAUTHORIZED: missing, invalid or revoked, or a key on a route that does not accept one.
- KEY_EXPIRED: the key passed the expiry it was issued with. Issue a new one; an expired key cannot be rotated.
- KEY_IP_NOT_ALLOWED: the key is pinned to source addresses and this request came from another.
403
DEVELOPER_FEATURE_DISABLED: developer tools are off for your organization. Or the refusals every write can answer: FORBIDDEN, ACCOUNT_BLOCKED, INSUFFICIENT_SCOPE.
429
Too many requests. The default ceiling is 100 requests per minute per API credential on a 60-second window. High-volume payout and reconciliation routes declare a 600/minute override, and batch submission a 30/minute ceiling. A separate 2,000/minute per-source-IP abuse ceiling always applies.

Obey Retry-After; it is in seconds and is authoritative. A 429 means the request was refused before the handler ran. Retry reads normally; retry an idempotent mutation with its same Idempotency-Key.

Error body · Error

typestringRequired
Stable machine-readable code.
detailstringRequired
What went wrong, in a sentence. Always a string, so detail.toLowerCase() is safe.
More
This is the field to read on BAD_REQUEST and PROVIDER_REJECTED, where the type alone does not name the condition.
messagestringRequired
The same text as detail, kept for integrations written before detail existed. Read detail.
resolutionstringOptional
What to do about it, when there is a specific answer. It is not on every error (it is absent on BAD_REQUEST, NOT_FOUND, PAYOUT_NOT_CANCELABLE and DESTINATION_ACCOUNT_NOT_FOUND), so treat it as optional and fall back to detail.
statusintegerRequired
HTTP status, repeated in the body.
statusCodeintegerRequired
The same value as status, kept for integrations written before status existed. Read status.
requestIdstringRequired
Quote this to support and we can find the exact request. Also sent as the x-request-id response header, which is the only place it appears on a successful response. Success bodies do not carry it. Send your own x-request-id on the request and we use it, so your trace and ours share one identifier; otherwise we mint one.
errorsarray of stringOptional
Present on VALIDATION_ERROR; names each field that failed.
originalIdempotencyKeystringOptional
On DUPLICATE_REQUEST_DETECTED only. Send the request again with this to receive the original payout instead of making a second one. Without it there is no way to recover except by risking a double payment.
originalPayoutIdstringOptional
On DUPLICATE_REQUEST_DETECTED only. The payout the first request created.
originalBatchIdstringOptional
On a batch DUPLICATE_REQUEST_DETECTED. The run the first request created.
originalRequestIdstringOptional
On a 409 PAYOUT_OUTCOME_UNKNOWN replay. The requestId of the call whose outcome is unknown; quote it to support.
existingRecipientIdstringOptional
On BANK_ACCOUNT_ALREADY_LINKED. The recipient in your organization that already holds this account.
existingMethodIdstringOptional
On BANK_ACCOUNT_ALREADY_LINKED. The payment method on that recipient.

Branch on type, never on the status or the message. Every error type is listed with what to do about it.

Avvio Partner Payouts · Sandbox · operation createSandboxWebhookEndpoint

Try it: Create a sandbox webhook endpoint

POST https://api.avvio.xyz/business/api/v1/payments/organizations/{orgId}/sandbox/webhook-endpoints

API key Required

Test keys only. Sent as x-api-key through this site's proxy to the Avvio API, never saved, and cleared when you close this dialog.

orgId pathRequired

Body JSON

Was this page helpful?