Skip to main content
POST
/
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>",
  "webhookId": "<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

companyid
string
required
The unique identifier of your company

Body Parameters

appId
string
The unique identifier of the app to send the webhook message to.
Either appId or webhookId must be provided, but not both.
webhookId
string
The unique identifier of the webhook to send the message to.
Either appId or webhookId must be provided, but not both.
payload
object
required
The payload to be sent in the webhook message

Response

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

Response Example