XPxpaycheckout

PUT /webhook/{webhookConfigId}

Update an existing webhook configuration. Use this to rotate the event signer, change the destination endpoint, or adjust the subscribed event types.

Request

  • Base URL
    https://api.xpaycheckout.com
  • URL
    https://api.xpaycheckout.com/webhook/{webhookConfigId}
  • Auth
    HTTP basic

Path parameters

webhookConfigIdstring required

Identifier of the webhook configuration to update

Headers

Idempotency-Keystring

A unique key for making the request idempotent. Must match pattern: ^[a-zA-Z0-9\-_:\.]+$. See Idempotent Requests for more details.

Request body

eventSignerstring required

Secret used to sign outbound webhook events. Provide a value that you will use to verify the signature.

endpointstring required

Public HTTPS URL where xPay should POST webhook events.

subscribedEventTypesstring[] required

List of event types to subscribe to. Refer to webhook events for the full list of available events.

Example request

{
  "eventSigner": "secret_key",
  "endpoint": "https://your-webhook-endpoint.com/webhook",
  "subscribedEventTypes": [
    "intent.created",
    "intent.success",
    "intent.failed",
    "intent.refunded",
    "intent.checkout_opened",
    "subscription.trialing",
    "subscription.cycle_charged"
  ]
}

Response

Webhook configuration updated successfully. No content is returned.

Changes

No recorded changes to this operation across all 2 revisions of this API.