POST
/
v2
/
webhook
curl --request POST \
  --url https://api.sandbox.solidfi.com/v2/webhook \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "description": "Transaction Webhook",
  "url": "http://test-url.com/txn-webhook",
  "events": [
    "transaction.status.declined",
    "transaction.status.received"
  ]
}'
{
  "id": "whk_0190e7185e4874dab687e7af88f6f368",
  "client_id": "cli_01901368dbc174a9864a7cb156b0a207",
  "description": "Transaction Webhook",
  "url": "http://test-url.com/txn-webhook",
  "events": [
    "transaction.status.declined",
    "transaction.status.received"
  ],
  "status": "active",
  "timestamps": {
    "created_at": "2024-07-24T23:34:12Z",
    "updated_at": "2024-07-25T10:22:11Z",
    "deleted_at": "2024-07-26T05:45:19Z"
  }
}

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.

Example:

"{{api_key}}"

Body

application/json
​
description
string

description of the webhook

Example:

"Transaction webhook"

​
url
string

url of the webhook endpoint

Example:

"http://test-url.com/txn-webhook"

​
events
string[]

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

Response

201
application/json
Create a Webhook
​
id
string

unique id of the webhook created

Example:

"whk_a8d2b191fa0e960d8e49a4bfd320e07b"

​
client_id
string

unique id of the client that issued the card

Example:

"cli_64c6c87ee9d609f36a6f390dc378a4ce"

​
description
string

description of the webhook

Example:

"Transaction webhook"

​
url
string

url of the webhook endpoint

Example:

"http://test-url.com/txn-webhook"

​
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

Example:

"pPibTgWHeiAAlJR7I0gzuXJpU3iNcwlf"

​
status
enum<string>

status of the webhook

Available options:
active,
inactive
Example:

"active"

​
timestamps
object
List all WebhooksRetrieve a Webhook