For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
LoginSandbox
Platform GuidesAPI DocsSDKMCP ServerChangelog
Platform GuidesAPI DocsSDKMCP ServerChangelog
  • Solvimon API
    • Base URL
    • Authentication
    • HTTP status codes
    • Resources
    • Standardisation
  • Configuration API
      • GETGet a webhook by resource ID
      • DELDelete an existing webhook
      • PATCHPatch an existing webhook
      • DELRemove the webhook secret, this will roll the existing one
      • PATCHGet a new webhook secret, this rolls the current token
      • POSTTrigger notification for a webhook in penalty box
      • POSTTest a webhook connection
      • GETGet a list of all webhooks
      • POSTCreate a web hook
      • GETGet a list of all available actions
      • POSTTest a webhook connection before create a webhook
  • Identity API
  • Transaction API
  • Event API
LoginSandbox
Configuration APIWebhooks

Get a list of all webhooks

GET
/v:version/webhooks
GET
/v:version/webhooks
$curl https://test.api.solvimon.com/v1/webhooks \
>     -H "X-API-KEY: <apiKey>"
1{
2  "data": [
3    {
4      "object_type": "string",
5      "id": "string",
6      "username": "string",
7      "api_header_field": "string",
8      "url": "string",
9      "included_actions": [
10        "string"
11      ],
12      "excluded_actions": [
13        "string"
14      ],
15      "active": true,
16      "penalty_box": "string",
17      "secret_key": "string",
18      "signing_protocol": "string",
19      "previous_secret_key": "string",
20      "previous_signing_protocol": "string",
21      "secret_rolled_at": "string",
22      "include_previous_data": true,
23      "authentication_type": "PASSWORD",
24      "penalty_box_data": {
25        "retry_count": 1,
26        "retry_at": "string",
27        "cause": "string",
28        "payload": "string"
29      },
30      "name": "string",
31      "reference": "string"
32    }
33  ],
34  "links": {
35    "first": "string",
36    "previous": "string",
37    "current": "string",
38    "next": "string"
39  },
40  "limit": 1,
41  "page": 1,
42  "total_number_of_pages": 1
43}
Requires the WEBHOOK.VIEW permission.
Was this page helpful?
Previous

Create a web hook

Next
Built with

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version

Headers

x-platform-idstringOptional
Platform ID.

Query parameters

limitintegerOptional
The amount of records shown in the list
pageintegerOptional
The page which is going to be shown
order_bystringOptional
The parameter by which the response is ordered.
order_directionstringOptional
The order direction by which the response is ordered.

Response

OK
datalist of objects
linksobject
limitinteger or null
pageinteger or null
total_number_of_pagesinteger or nullDeprecated

Errors

401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error