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
The unique identifier of the webhook
Response
Indicates if the request was successful
A message describing the result of the operation
The webhook object
Show Properties
Show Properties
Unique identifier for the webhook
URL where webhook events will be sent
Secret key for webhook verification
Authentication method configuration
Show Properties
Show Properties
Authentication method type (hmac, api_key, or basic)
Custom header name for HMAC signature (if method is hmac)
Secret used for HMAC signature generation (if method is hmac)
API key value (if method is api_key)
Custom header name for API key (if method is api_key)
Username for basic authentication (if method is basic)
Password for basic authentication (if method is basic)
Timestamp when the webhook was created
Timestamp when the webhook was last updated
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"
}
}
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>"
}
}Get Started
API Reference
- Projects
- Apps
- Webhooks
- Webhook Messages
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
The unique identifier of the webhook
Response
Indicates if the request was successful
A message describing the result of the operation
The webhook object
Show Properties
Show Properties
Unique identifier for the webhook
URL where webhook events will be sent
Secret key for webhook verification
Authentication method configuration
Show Properties
Show Properties
Authentication method type (hmac, api_key, or basic)
Custom header name for HMAC signature (if method is hmac)
Secret used for HMAC signature generation (if method is hmac)
API key value (if method is api_key)
Custom header name for API key (if method is api_key)
Username for basic authentication (if method is basic)
Password for basic authentication (if method is basic)
Timestamp when the webhook was created
Timestamp when the webhook was last updated
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"
}
}
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>"
}
}