Skip to content
/Draft Events

Draft Created
Webhook

Request

Triggered when a draft enquiry is created

Security
apikey
Headers
Bodyapplication/json
dataobject(EnquiryMessage)required

The main data payload of the webhook

actionstringrequired

The type of action that triggered this webhook

Enum:"CREATED""UPDATED""DELETED"
Example:"CREATED"
changesArray of objects(ValueChangeObjectObject)required

List of changes that occurred in this webhook event

triggerobject(Trigger)

Information about what triggered this webhook

resourceTypestringrequired

The type of resource the event belongs to

Enum:"DRAFT_ENQUIRY""ENQUIRY""OFFER""APPROVAL_REQUEST"
Example:"OFFER"
createdAtstring, (date-time)required

When the event was thrown

Example:"2023-01-01T12:00:00Z"
webhookTimestampstring, (date-time)required

When the webhook was sent

Example:"2023-01-01T12:00:01Z"
webhookIdstringrequired

Unique identifier for this webhook

Example:"507f1f77bcf86cd799439011"
Payload
{
  "data": { … },
  "action": "CREATED",
  "changes": [ … ],
  "trigger": { … },
  "resourceType": "OFFER",
  "createdAt": "2023-01-01T12:00:00Z",
  "webhookTimestamp": "2023-01-01T12:00:01Z",
  "webhookId": "507f1f77bcf86cd799439011"
}

Responses

Success - No Content