POST
/
v2
/
webhook

Headers

api-key
string
required

API key is required to call Solid APIs. You can view and manage your API keys in the Solid dashboard.

Body

application/json
description
string

description of the webhook

url
string

url of the webhook endpoint

events
string[]

an array of events to enable for this webhook endpoint. Example ["transaction.status.declined","transaction.status.received"]

Response

201 - application/json
id
string

unique id of the webhook created

client_id
string

unique id of the client that issued the card

description
string

description of the webhook

url
string

url of the webhook endpoint

events
string[]

an array of events to enable for this webhook endpoint. Example ["transaction.status.declined","transaction.status.received"]

secret
string

webhook signing secret which is returned only at the time of webhook creation

status
enum<string>

status of the webhook

Available options:
active,
inactive
timestamps
object