WebhookPayload

Schema

Name / Description Type / Format Example
name
A descriptive name for this payload
 string "string"
url
The Url that payload will be sent to
 string uri "string"
attempts
The number of attempts that have been made to deliver this payload
 integer int32 0
statusCode
The status code received from the Url
 integer int32 0
taskStatus string "Queued" "Sent" "Failed" "Processing"
statusMessage
A message to accompany the status
 string "string"
created
The date and time this payload was created
 string date "2024-12-22"
payload
the JSON payload that will be sent to the URl
 {}
id
The unique id of the object
 string uuid "string"

JSON Example 

{
  "name": "string",
  "url": "string",
  "attempts": 0,
  "statusCode": 0,
  "taskStatus": "Queued",
  "statusMessage": "string",
  "created": "2024-12-22",
  "payload": {},
  "id": "string"
}

References

Contained in Models
Webhook
Consumed by Operations

- none -

Returned by Operations
Get WebhookPayload
Introduction Webhooks