Skip to main content

Webhook Payload Format

When an event occurs, we'll send a POST request to your webhook URL with the following payload:

{
"id": "event-uuid-123",
"event": "wildfire.event.created",
"timestamp": "2023-01-01T16:45:00.000Z",
"data": {
"id": 100,
"location_id": 5,
"start": "2023-01-01T16:40:00.000Z",
"end": null,
"is_correct": null,
"notes": null,
"created_at": "2023-01-01T16:45:00.000Z"
}
}

Payload Fields​

FieldDescriptionType
idUnique identifier for this webhook eventstring
eventType of event (wildfire.event.created, wildfire.event.updated)string
timestampISO 8601 timestamp when the event occurredstring
dataThe wildfire event data that triggered this webhookobject

Event Types​

Event TypeDescription
wildfire.event.createdA new wildfire event has been created
wildfire.event.updatedAn existing wildfire event was updated