Webhook Message
curl --request POST \
--url https://api.us.vartiq.com/webhook-messages \
--header 'Content-Type: application/json' \
--header 'companyid: <companyid>' \
--header 'x-api-key: <api-key>' \
--data '{
"appId": "<string>",
"payload": {}
}'{
"success": true,
"message": "<string>",
"data": {
"webhookMessage": {
"id": "<string>",
"isDelivered": true,
"payload": "<string>",
"signature": "<string>",
"headers": [
{}
],
"createdAt": "<string>",
"updatedAt": "<string>"
},
"webhookMessageAttempt": {
"id": "<string>",
"isProcessed": true,
"isResend": true,
"statusCode": 123,
"response": "<string>",
"headers": [
{}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}Headers
The unique identifier of your company
Body Parameters
The unique identifier of the app to send the webhook message to
The payload to be sent in the webhook message
Response
Indicates if the request was successful
A message describing the result of the operation
The created webhook message details
Show Properties
Show Properties
Details of the created webhook message
Show Properties
Show Properties
Unique identifier for the webhook message
Indicates if the message has been delivered
The stringified payload of the message
HMAC signature of the message
Array of header objects containing key-value pairs
Timestamp when the message was created
Timestamp when the message was last updated
Details of the delivery attempt
Show Properties
Show Properties
Unique identifier for the attempt
Indicates if the attempt has been processed
Indicates if this is a resend attempt
HTTP status code of the attempt
Response received from the webhook endpoint
Array of header objects containing key-value pairs
Timestamp when the attempt was created
Timestamp when the attempt was last updated
Response Example
{
"data": {
"webhookMessage": {
"headers": [
{
"key": "x-app",
"value": "x-value",
"_id": "6812160256d753f3b41e1c66"
},
{
"key": "Content-Type",
"value": "application/json",
"_id": "6812160256d753f3b41e1c67"
}
],
"id": "wm_01JT3AC28MCG19W3DP8XG99832",
"isDelivered": false,
"payload": "{\"hello\":\"one\"}",
"signature": "ba245c491633352932de63696a47de3d3da5d75e61b09ecc7614a5979b0db762",
"webhook": "6812160256d753f3b41e1c65",
"_id": "6812160656d753f3b41e1c6a",
"createdAt": "2025-04-30T12:22:30.426Z",
"updatedAt": "2025-04-30T12:22:30.426Z",
"__v": 0
},
"webhookMessageAttempt": {
"awsMessageId": null,
"headers": [
{
"key": "x-app",
"value": "x-value",
"_id": "6812160256d753f3b41e1c66"
},
{
"key": "Content-Type",
"value": "application/json",
"_id": "6812160256d753f3b41e1c67"
}
],
"id": "wma_01JT3AC2BWWCWMAWVR7056VNQS",
"isProcessed": false,
"isResend": false,
"response": null,
"statusCode": null,
"webhookMessage": "6812160656d753f3b41e1c6a",
"_id": "6812160656d753f3b41e1c6e",
"createdAt": "2025-04-30T12:22:30.527Z",
"updatedAt": "2025-04-30T12:22:30.527Z",
"__v": 0
}
},
"message": "Webhook message created successfully",
"success": true
}
curl --request POST \
--url https://api.us.vartiq.com/webhook-messages \
--header 'Content-Type: application/json' \
--header 'companyid: <companyid>' \
--header 'x-api-key: <api-key>' \
--data '{
"appId": "<string>",
"payload": {}
}'{
"success": true,
"message": "<string>",
"data": {
"webhookMessage": {
"id": "<string>",
"isDelivered": true,
"payload": "<string>",
"signature": "<string>",
"headers": [
{}
],
"createdAt": "<string>",
"updatedAt": "<string>"
},
"webhookMessageAttempt": {
"id": "<string>",
"isProcessed": true,
"isResend": true,
"statusCode": 123,
"response": "<string>",
"headers": [
{}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}Get Started
API Reference
- Projects
- Apps
- Webhooks
- Webhook Messages
Webhook Message
curl --request POST \
--url https://api.us.vartiq.com/webhook-messages \
--header 'Content-Type: application/json' \
--header 'companyid: <companyid>' \
--header 'x-api-key: <api-key>' \
--data '{
"appId": "<string>",
"payload": {}
}'{
"success": true,
"message": "<string>",
"data": {
"webhookMessage": {
"id": "<string>",
"isDelivered": true,
"payload": "<string>",
"signature": "<string>",
"headers": [
{}
],
"createdAt": "<string>",
"updatedAt": "<string>"
},
"webhookMessageAttempt": {
"id": "<string>",
"isProcessed": true,
"isResend": true,
"statusCode": 123,
"response": "<string>",
"headers": [
{}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}Headers
The unique identifier of your company
Body Parameters
The unique identifier of the app to send the webhook message to
The payload to be sent in the webhook message
Response
Indicates if the request was successful
A message describing the result of the operation
The created webhook message details
Show Properties
Show Properties
Details of the created webhook message
Show Properties
Show Properties
Unique identifier for the webhook message
Indicates if the message has been delivered
The stringified payload of the message
HMAC signature of the message
Array of header objects containing key-value pairs
Timestamp when the message was created
Timestamp when the message was last updated
Details of the delivery attempt
Show Properties
Show Properties
Unique identifier for the attempt
Indicates if the attempt has been processed
Indicates if this is a resend attempt
HTTP status code of the attempt
Response received from the webhook endpoint
Array of header objects containing key-value pairs
Timestamp when the attempt was created
Timestamp when the attempt was last updated
Response Example
{
"data": {
"webhookMessage": {
"headers": [
{
"key": "x-app",
"value": "x-value",
"_id": "6812160256d753f3b41e1c66"
},
{
"key": "Content-Type",
"value": "application/json",
"_id": "6812160256d753f3b41e1c67"
}
],
"id": "wm_01JT3AC28MCG19W3DP8XG99832",
"isDelivered": false,
"payload": "{\"hello\":\"one\"}",
"signature": "ba245c491633352932de63696a47de3d3da5d75e61b09ecc7614a5979b0db762",
"webhook": "6812160256d753f3b41e1c65",
"_id": "6812160656d753f3b41e1c6a",
"createdAt": "2025-04-30T12:22:30.426Z",
"updatedAt": "2025-04-30T12:22:30.426Z",
"__v": 0
},
"webhookMessageAttempt": {
"awsMessageId": null,
"headers": [
{
"key": "x-app",
"value": "x-value",
"_id": "6812160256d753f3b41e1c66"
},
{
"key": "Content-Type",
"value": "application/json",
"_id": "6812160256d753f3b41e1c67"
}
],
"id": "wma_01JT3AC2BWWCWMAWVR7056VNQS",
"isProcessed": false,
"isResend": false,
"response": null,
"statusCode": null,
"webhookMessage": "6812160656d753f3b41e1c6a",
"_id": "6812160656d753f3b41e1c6e",
"createdAt": "2025-04-30T12:22:30.527Z",
"updatedAt": "2025-04-30T12:22:30.527Z",
"__v": 0
}
},
"message": "Webhook message created successfully",
"success": true
}
curl --request POST \
--url https://api.us.vartiq.com/webhook-messages \
--header 'Content-Type: application/json' \
--header 'companyid: <companyid>' \
--header 'x-api-key: <api-key>' \
--data '{
"appId": "<string>",
"payload": {}
}'{
"success": true,
"message": "<string>",
"data": {
"webhookMessage": {
"id": "<string>",
"isDelivered": true,
"payload": "<string>",
"signature": "<string>",
"headers": [
{}
],
"createdAt": "<string>",
"updatedAt": "<string>"
},
"webhookMessageAttempt": {
"id": "<string>",
"isProcessed": true,
"isResend": true,
"statusCode": 123,
"response": "<string>",
"headers": [
{}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}