Skip to main content
GET
/
webhook
/
{webhookConfigId}
cURL
curl --request GET \
  --url https://api.xpaycheckout.com/webhook/{webhookConfigId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "webhookConfigId": "whc_gKAi2oZN1AeU7BfV",
  "webHookUrl": "https://your-webhook-endpoint.com/webhook",
  "eventSigner": "secret_key",
  "subscribedEventTypes": [
    "intent.checkout_opened",
    "intent.created",
    "intent.failed",
    "intent.refunded",
    "intent.success",
    "subscription.trialing",
    "subscription.cycle_charged"
  ],
  "isActive": true
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
webhookConfigId
string
required

Identifier of the webhook configuration to retrieve

Response

Webhook configuration details

​
webhookConfigId
string
required

Unique identifier for the webhook configuration

Example:

"whc_gKAi2oZN1AeU7BfV"

​
webHookUrl
string
required

Webhook endpoint URL that was registered

Example:

"https://your-webhook-endpoint.com/webhook"

​
eventSigner
string
required

Secret used to sign outgoing events

Example:

"secret_key"

​
subscribedEventTypes
string[]
required

Events configured for this webhook

Example:
[
  "intent.checkout_opened",
  "intent.created",
  "intent.failed",
  "intent.refunded",
  "intent.success",
  "subscription.trialing",
  "subscription.cycle_charged"
]
​
isActive
boolean
required

Indicates whether the webhook configuration is active

Example:

true