Sign in

v1

latestOpenAPI 3.0.02026-07-265892227.1 KB
Webhooks

Get a webhook

get/webhooks/{id}

Path parameters

idstring required
Example:wh_z1urYtVFgEebtcj8fxp4v

Unique identifier for the Webhook

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Response

idstring required

Unique identifier for the Webhook

createdAtstring required

Datetime in UTC timezone at which this object was created. Follows the Datetime ISO.

updatedAtstring required

Datetime in UTC timezone at which this object was updated. Follows the Datetime ISO.

mode'live' | 'sandbox' required

Mode in which this Webhook exists. The sandbox mode can be used during the integration phase and is available as soon as the merchant account is created. No real transactions are made in this mode. The live mode has to be used to make real transactions.

descriptionstring

An optional description of what the webhook is used for.

eventsstring[] required

The list of events to enable for this endpoint.

metadataobject required

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

secretstring

The endpoint’s secret, used to generate webhook signatures. Only returned at creation.

status'enabled' | 'disabled' required

The webhook status

urlstring required

Fully qualified url of the webhook endpoint.

Example response

{
  "id": "wh_z1urYtVFgEebtcj8fxp4v",
  "createdAt": "2020-10-15T12:09:49.355Z",
  "updatedAt": "2020-10-15T12:09:49.355Z",
  "mode": "live",
  "description": "This is a webhook trigger upon payment & payment_intent creation",
  "events": [
    "payment.created",
    "payment_intent.created"
  ],
  "metadata": {},
  "secret": "5257a869e7ecebeda32affa62cd...",
  "status": "enabled",
  "url": "https://my.webhook.target"
}