Discussions

Ask a Question
Back to all

How to configure Corrigo Webhook subscription for WorkOrder / WorkOrderCost events (AP integration)

We’re integrating Corrigo Enterprise with our Accounts Payable system (AFI).

Environment: Stage company (Corrigo Enterprise), Americas region
We already have OAuth working (/OAuth/token) and can successfully call Base/Query APIs such as:
GET {Host}/api/v1/base/WorkOrder/{Id}
POST {Host}/api/v1/query/WorkOrder

From the APIs we can retrieve WorkOrder and WorkOrderCost data and see all the fields needed to build an AP invoice.

Our goal now is to move from polling to an event‑driven approach using Corrigo Webhooks / Corrigo Sync, so that we are only notified when a work order or its costs become “invoice‑ready”.

What we’re trying to do

Receive a webhook when:
A WorkOrder is completed / verified (or reaches a status we can treat as invoice‑ready), and/or
A WorkOrderCost / Vendor Invoice status changes (e.g., “Vendor Invoice Status Changed” in the docs).
In our listener, we will:
Validate the webhook signature
Read the WorkOrder / WorkOrderCost id from the payload
Call the Base API (GET WorkOrder, GET WorkOrderCost) to pull full details and then create/update the invoice in AFI.

Questions about configuration

Where exactly do we configure the webhook subscription?

Is this done in Corrigo Sync / Corrigo Webhook UI for our company?
Which menu path should our Corrigo admin follow to:
Create a subscription
Enter our HTTPS endpoint URL
Define the signing key / secret used for the HMAC signature?
Which event categories / event types should we select?

Based on the Webhook documentation, we are looking at:

Event category for Work Order Costs – especially something like “Vendor Invoice Status Changed” (and/or “Internal Costs Status Changed”).
Event category for Work Order Updates – status changes such as Complete / Verified / Cancel / Reopen, etc.
Can you confirm the recommended event set for an AP‑invoice integration so that:

We receive an event only when something relevant to AP changes (status, costs, vendor invoice status), and
We do not get events for historical work orders that were already fully processed before we enabled the webhook?
How are events triggered in practice?

Which user actions in the Corrigo UI (or which API calls) generate the WorkOrder / WorkOrderCost events above?
Is there any delay or batching, or should we expect near real‑time delivery?
For testing, is the recommended approach simply:
Configure the subscription,
Complete/verify a WorkOrder in the Stage UI,
Check that our webhook endpoint receives a POST with the WorkOrder/WorkOrderCost ids?
Payload details / examples

The Webhook docs mention Entities[0].Data containing the WorkOrder.
Could you provide (or confirm) an example payload for:
A WorkOrder status‑change event
A WorkOrderCost / Vendor Invoice status‑change event
so we can validate that we are parsing the data correctly?
Licensing / enablement

Are there any specific feature flags, subscriptions, or Corrigo Sync configuration steps that need to be enabled for our Stage company before webhook events will start firing?

What we have already done

Successfully authenticated with OAuth and can call Base and Query APIs.
Verified that we can read WorkOrder and WorkOrderCost, including all AP‑related fields.
Reviewed these docs:
Corrigo Enterprise REST API – Base, Query, Command
Webhook overview page

We are now looking for step‑by‑step guidance (or confirmation) on:

Exact UI path and settings to configure the webhook subscription for our company.
The recommended event types for an AP invoice integration.
How to test that events are firing correctly in a Stage environment.
Any concrete examples or screenshots from the Corrigo side would be very helpful. Thanks in advance.