ReferenceApi
Create webhook subscription
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
url*string
eventTypes*array<>
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/webhooks" \ -H "Content-Type: application/json" \ -d '{ "url": "http://example.com", "eventTypes": [ "organization.created" ] }'{ "webhookId": "string", "url": "http://example.com", "eventTypes": [ "organization.created" ], "signingSecretPreview": "string", "createdAt": "string", "signingSecret": "string"}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }, "errors": [ { "detail": "string", "pointer": "string" } ]}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}