GET
/
v2
/
webhook
curl --request GET \
  --url https://api.sandbox.solidfi.com/v2/webhook \
  --header 'api-key: <api-key>'
{
  "total": 1,
  "data": [
    {
      "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"
      }
    }
  ],
  "starting_after": "",
  "ending_before": "",
  "has_more": false
}

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}}"

Query Parameters

​
limit
number

number of records to return

Example:

10

​
starting_after
string

A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 50 records, ending with Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky, your subsequent call can include starting_after=Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky in order to fetch the next page of the list.

Example:

"Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky"

​
ending_before
string

A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 50 records, starting with Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky, your subsequent call can include ending_before= Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky in order to fetch the previous page of the list.

Example:

"Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky"

Response

200
application/json
List all Webhooks
​
total
number

total number of records

Example:

1

​
data
object[]
​
has_more
enum<string>

if there are more records to iterate or not

Available options:
true,
false
Example:

"true"

​
starting_after
string

A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 50 records, ending with Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky, your subsequent call can include starting_after=Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky in order to fetch the next page of the list.

Example:

"Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky"

​
ending_before
string

A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 50 records, starting with Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky, your subsequent call can include ending_before= Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky in order to fetch the previous page of the list.

Example:

"Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky"

List all Webhook EventsCreate a Webhook