openlabelengine

Webhook integration

Start an automation from an external event.

Send a small event to the configured HTTP trigger, keep its identity through retries, and follow the automation and print results separately.

Use the configured trigger

The Center endpoint is POST /api/v1/flows/{flowId}/triggers/{triggerId}/webhook. Substitute the saved automation's ID and its trigger.http.endpoint node ID. An automation may have more than one trigger, so the node ID is part of the address.

Configure the node's secret parameter as a cred:// reference to a saved credential. Send that credential's trigger secret as Authorization: Bearer … or X-OLE-Trigger-Secret, over your configured HTTPS address. This is the trigger's shared secret; an ordinary Center service-account token is not a substitute.

A missing or unresolvable configured secret leaves the trigger closed with HTTP 403. An incorrect supplied secret returns HTTP 401.

Keep the payload within 64 KiB

RequirementCurrent behavior
Body sizeAt most 64 KiB (65,536 bytes). An oversized body returns HTTP 413 with code flows.trigger.payload_too_large and limitBytes: 65536.
Body shapeA JSON object containing the event context. A trigger that needs no values may receive an empty body or {}.
FieldsMatch the context values the saved automation expects. Receiving JSON does not automatically map it to every label input.

Measure the encoded request body in bytes when preparing an integration. Keep large documents and bulk data in an appropriate source that your configured workflow can read.

Give each event a stable identity

Send an Idempotency-Key for the business event and retain it when retrying that same delivery. Without the header, the Center derives the key from a SHA-256 hash of the raw request body. Byte changes can therefore change the derived identity; separate intended events with identical bodies need distinct explicit keys.

Do not reuse one key for different business events or use a new key merely because an earlier print outcome is uncertain. Webhook deduplication identifies an already recorded event; it does not decide whether a physical label needs replacement.

Read acceptance and execution separately

  • HTTP 202: a new event was recorded. Keep the returned event identifier.
  • HTTP 200 with duplicate: true: this delivery matched an existing event and returns that event.
  • An error response: read its code before retrying. Check the address, trigger type, secret, body shape and size as applicable.

With the appropriate Center account or API permissions, inspect the automation's events and runs. Then inspect any resulting print jobs and archive records. Acceptance of the webhook is not confirmation of a print.

Plan the data mapping → · Follow print requests and outcomes →

Runs for 7 days

Test it now

Your own instance, running in seconds. Nothing to install.

.openlabelengine.com

We fill this in from your email — change it if you like.

You will use this to sign in to your instance.

Isolated instance, runs for 7 days. We email you before it expires. Want to run it yourself instead? Deploy it.