Skip to Content
CheckoutAPI ReferenceSettingsUpdate the webhook URL and display name

Update the webhook URL and display name

PATCH/settings

Set 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

HeaderDescriptionRequired
AuthorizationBearer token with your secret API keyyes

Request Body

FieldTypeRequiredDescription
webhook_urlstring | null
display_namestring | 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

StatusDescription
200The updated settings.
400Validation error
401Missing or invalid authentication
403API key lacks the required scope

Response body

FieldTypeRequiredDescription
webhook_urlstring | nullyes
display_namestring | null
webhook_secretstring

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"
  }
}

Start building

XO

Request Demo

Schedule a call with our team

Select a product
Arrow right

Start building
Grateful

Contact Us

We're here to help