Skip to content

Webhooks

Outbound webhooks: Orderwerks posts a signed JSON envelope to your HTTPS endpoint when orders, quotes, shipments, catalog items, customers or vendor sources change, or when an order enters a chosen workflow step. Endpoints are managed here or under Business Settings > Webhooks. See the Webhooks guide for verification, retries and the event list. A business admin switches the feature on under Business Integrations; a business admin's credentials are needed to manage endpoints.

Operations

List subscribable event types

Request

The event types an endpoint may list in events, plus the name of the workflow event that endpoint workflow triggers and the "send webhook" workflow step action produce.

Security
(ApiKey and ApiSecret) or (UserGuid and UserToken and SupplierGuid)
curl -i -X GET \
  https://docs.orderwerks.com/_mock/openapi/v1/webhook-events \
  -H 'x-apiKey: YOUR_API_KEY_HERE' \
  -H 'x-apiSecret: YOUR_API_KEY_HERE'

Responses

Event types.

Bodyapplication/json
eventsArray of strings
Example:
[
  "order.created",
  "order.submitted",
  "order.state_changed",
  "order.deleted",
  "shipment.created"
]
workflow_eventstring
Example:"workflow.fired"
Response
{
  "events": [
    "order.created",
    "order.submitted",
    "order.state_changed",
    "order.deleted",
    "shipment.created"
  ],
  "workflow_event": "workflow.fired"
}