Skip to main content
GET
/
webhooks
/
{webhookId}
Get Webhook
curl --request GET \
  --url https://api.us.vartiq.com/webhooks/{webhookId} \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "url": "<string>",
    "secret": "<string>",
    "customHeaders": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "headers": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "authMethod": {
      "method": "<string>",
      "hmacHeader": "<string>",
      "hmacSecret": "<string>",
      "apiKey": "<string>",
      "apiKeyHeader": "<string>",
      "userName": "<string>",
      "password": "<string>"
    },
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

​
URL Parameters

​
webhookId
string
required
The unique identifier of the webhook

​
Response

​
success
boolean
Indicates if the request was successful
​
message
string
A message describing the result of the operation
​
data
object
The webhook object

​
Response Example

{
  "success": true,
  "message": "Webhook retrieved successfully",
  "data": {
    "id": "wh_01JT39T79CFY20Z7G0M2KC4HVC",
    "name": "heelo",
    "url": "https://exp.com",
    "secret": "01JT39T79HMJHEYQ9FXZ9VM2XC",
    "customHeaders": [
      {
        "key": "x-app",
        "value": "x-value"
      }
    ],
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "authMethod": {
      "hmacHeader": "x-Vartiq-signature",
      "hmacSecret": "uPvKnaxMwD1gHs1uFNJh-UEn3D5ha5WZcS3WTMVUExY",
      "method": "hmac"
    },
    "createdAt": "2025-04-30T12:12:45.756Z",
    "updatedAt": "2025-04-30T12:12:45.756Z"
  }
}