Webhooks

Webhook subscriptions allow for automated notifications to your designated systems on the occurrence of certain triggers in GAINS.

The current available webhook triggers are:

  • Submission of Purchase Orders (PO's)
  • Submission of Transfer Orders (TO's)
  • Submission of Work Orders (WO's)

Webhook notifications are issued based on the settings you have defined for the following:

  • Payload Max Items - allows you to limit the number of records produced in the payload
  • Payload Interval - define the gap (in seconds) between notifications
  • Retry Attempts - after a failed attempt, specify the number of times we should attempt to re-send a payload
  • Retry Gap - specify the time (in minutes) between retry attempts

Webhook Behaviour

A single webhook notification will only contain one record type - either PO's, TO's or WO's. If GAINS core has a combination of PO's, TO's and WO's waiting to be sent to you, PO's will always be sent first. Thereafter, the remaining of TO's and WO's will be sent based on the one that entered the queue first.

Successive payloads will always respect the PayloadMaxItems and PayloadInterval parameters.