Update the webhook URL and display name
PATCH/settingsSet or clear the webhook endpoint URL that receives event deliveries, and/or the customer-facing display name. Pass null for webhook_url to disable webhooks, or for display_name to fall back to your account name. Omitted fields are left unchanged; only a first-time webhook_url configuration also returns webhook_secret.
Headers
| Header | Description | Required |
|---|---|---|
| Authorization | Bearer token with your secret API key | yes |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| webhook_url | string | null | — | |
| display_name | string | null | — |
Example Request
Request
const response = await fetch('https://checkout-api.exodus-int.com/settings', {
method: 'PATCH',
headers: {
Authorization: 'Bearer sk_live_xxxxxxxxxxxxxxxx',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"webhook_url": "https://yoursite.com/webhooks/exodus",
"display_name": "Acme Inc."
}),
});Responses
| Status | Description |
|---|---|
| 200 | The updated settings. |
| 400 | Validation error |
| 401 | Missing or invalid authentication |
| 403 | API key lacks the required scope |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
| webhook_url | string | null | yes | |
| display_name | string | null | — | |
| webhook_secret | string | — |
Example Response
{
"webhook_url": "https://yoursite.com/webhooks/exodus",
"display_name": "Acme Inc."
}Error Response
Error (e.g. 400)
{
"error": {
"type": "validation_error",
"message": "amount must be a positive number",
"param": "amount"
}
}