Webhooks Overviewlink

Webhooks enable real-time notifications when events occur in Infraspeak. They can save you resources as you will receive the notifications when an event is triggered, rather than polling the API to detect changes (which may lead you to hit the Rate Limit and get blocked).

Why Use Webhooks?link

Approach	Pros	Cons
Polling	Simple to implement	Wastes API calls, delay between events
Webhooks	Real-time, efficient	Requires endpoint setup, handling retries

Webhooks are ideal for:

Real-time changes and notifications
Syncing data to external systems
Triggering automated workflows
Building integrations that respond to events

How Webhooks Worklink

┌───────────────┐         ┌───────────────┐         ┌───────────────┐
│   Infraspeak  │         │   Event       │         │  Your App     │
│   Platform    │         │   Occurs      │         │  Endpoint     │
│               │         │               │         │               │
│ Work order    │    1    │ FAILURE_      │    2    │ POST /webhook │
│ created       │───────▶│ CREATED       │───────▶│               │
│               │         │               │         │               │
│               │         │               │    3    │ Process event │
│               │         │               │◀───────│ Return 200 OK │
└───────────────┘         └───────────────┘         └───────────────┘

An event occurs in Infraspeak (e.g., work order created).
Infraspeak sends an HTTP POST (or PATCH, depending on the webhook configuration) to your registered URL.
Your endpoint processes the event and returns a 2xx status.

Available Eventslink

Buy Orders (Purchases)link

Event	Trigger
`BUY_ORDER_CONFIRMED`	A Purchase Order is confirmed.
`BUY_ORDER_CREATED`	A Purchase Order is created.
`BUY_ORDER_RECEIVED`	A Purchase Order is received.
`BUY_ORDER_STATE_CHANGED`	A Purchase Order transits to any state.
`BUY_ORDER_STARTED`	A Purchase Order is started.
`BUY_ORDER_UPDATED`	A Purchase Order is updated.

Elements (Assets)link

Event	Trigger
`ELEMENT_CHARACTERISTICS_UPDATED`	The Assets' technical information is updated.
`ELEMENT_CREATED`	An Asset is created.
`ELEMENT_UPDATED`	An Asset is updated.

Failures (Work Orders)link

Event	Trigger
`FAILURE_APPROVED`	A Work Order is approved.
`FAILURE_CLOSED`	A Work Order is closed.
`FAILURE_COMPLETED_CONFIRMED`	A completed Work Order is confirmed.
`FAILURE_CREATED`	A Work Order is created.
`FAILURE_MESSAGE_CREATED`	A message is created on a Work Order.
`FAILURE_NOT_APPROVED`	A Work Order declined.
`FAILURE_PAUSE_REASON_UPDATED`	A Work Order's pause reason is changed.
`FAILURE_PAUSED`	A Work Order is paused.
`FAILURE_RESUMED`	A Work Order is resumed.
`FAILURE_STARTED`	A Work Order is started.
`FAILURE_STATE_CHANGED`	A Work Order transits to any state.
`FAILURE_UNDO_APPROVED`	An approved Work Order is disapproved.
`FAILURE_UPDATED`	A Work Order is updated.

Fileslink

Event	Trigger
`FILE_CREATED`	A Document is created.
`FILE_UPDATED`	A Document is updated.
`FILE_UPLOADED`	A file is uploaded to a (new or existing) Document.
`FILE_DELETED`	A Document is deleted.

Quotes (Sale Quotes)link

Event	Trigger
`QUOTE_ACCEPTED`	A Quote is approved.
`QUOTE_READY`	A Quote is set as ready.

Quote Requests (Purchase Quotes)link

Event	Trigger
`QUOTE_REQUEST_CREATED`	A Quote Request is created.
`QUOTE_REQUEST_STATE_CHANGED`	A Quote Request transits to any state.

Sell Orders (Sales)link

Event	Trigger
`SELL_ORDER_COMPLETED`	A Sale is completed.
`SELL_ORDER_CONFIRMED`	A Sale is confirmed.
`SELL_ORDER_UNCONFIRMED`	A confirmed Sale is unconfirmed.
`SELL_ORDER_UPDATED`	A Sale is updated.

Scheduled Works (Planned Job Orders)link

Event	Trigger
`SCHEDULED_WORK_COMPLETED`	A Planned Job Order is closed.
`SCHEDULED_WORK_COMPLETED_CONFIRMED`	A completed Planned Job Order is confirmed.
`SCHEDULED_WORK_CREATED_BY_FAILURE`	A Planned Job Order resulting from a Work Order is created.
`SCHEDULED_WORK_STATE_CHANGED`	A Planned Job Order transits to any state.
`SCHEDULED_WORK_UPDATED`	A Planned Job Order is updated.
`SCHEDULED_WORK_PAUSED`	A Planned Job Order is paused.

Planner Eventslink

Event	Trigger
`PLANNED_EVENT_DELETED`	A planned work event in the Planner is deleted.
`PLANNED_EVENT_FROM_SCHEDULED_WORK`	A planned work event is assigned to an operator in the Planner.
`PLANNED_EVENT_STATE_CHANGE`	A planned work event in the Planner transits to any state.
`PLANNED_EVENT_UPDATED`	A planned work event in the Planner is updated.

Other Eventslink

Event	Trigger
`MANUAL_METERING_CREATED`	A manual metering for an Asset is created.
`HOUSEKEEPER_ASSET_STATUS_CHANGED`	A Housekeeper Asset transits to any state.
`WORK_LOCATIONS_UPDATED`	A Planned Job's related Location is updated.