GET
/
webhooks
curl --request GET \
  --url https://api.us.vartiq.com/webhooks \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>",
      "secret": "<string>",
      "customHeaders": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "headers": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

​
Query Parameters

​
appId
string
required

Filter webhooks by app ID

​
Response

​
success
boolean

Indicates if the request was successful

​
message
string

A message describing the result of the operation

​
data
array

Array of webhook objects

​
Response Example

{
  "success": true,
  "message": "Webhooks retrieved successfully",
  "data": [
    {
      "id": "wh_01JT39DVQGKA1RV4QNJ1VFRNW2",
      "name": "heelo",
      "url": "https://exp.com",
      "secret": "01JT39DVQJW3A49TR3XXFVM939",
      "customHeaders": [
        {
          "key": "x-app",
          "value": "x-value"
        }
      ],
      "headers": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "createdAt": "2025-04-30T12:06:00.703Z",
      "updatedAt": "2025-04-30T12:06:00.703Z"
    }
  ]
}
GET
/
webhooks
curl --request GET \
  --url https://api.us.vartiq.com/webhooks \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>",
      "secret": "<string>",
      "customHeaders": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "headers": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

​
Query Parameters

​
appId
string
required

Filter webhooks by app ID

​
Response

​
success
boolean

Indicates if the request was successful

​
message
string

A message describing the result of the operation

​
data
array

Array of webhook objects

​
Response Example

{
  "success": true,
  "message": "Webhooks retrieved successfully",
  "data": [
    {
      "id": "wh_01JT39DVQGKA1RV4QNJ1VFRNW2",
      "name": "heelo",
      "url": "https://exp.com",
      "secret": "01JT39DVQJW3A49TR3XXFVM939",
      "customHeaders": [
        {
          "key": "x-app",
          "value": "x-value"
        }
      ],
      "headers": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "createdAt": "2025-04-30T12:06:00.703Z",
      "updatedAt": "2025-04-30T12:06:00.703Z"
    }
  ]
}