Overview

Webhooks are configured in order to notify the Flow1st Partner’s backend server on the final status of an order.

Webhook Configuration

Webhooks are configured under the Settings Tab in the Flow1st Console. A default webhook URL endpoint must be provided in order to enable Webhook Resend Functionality.

Webhook Payload

The following table describes the Webhook payload that will be sent to the Flow1st Partner Server

HTTP Headers

Header Name	Description
AccessToken	This is the Access Token field returned from the Authentication - Generate Access Token response. This should be in the format `Bearer <AccessToken>`
Content-Type	`application/json`
X-SIGNATURE	This is the header that will contain the signature of the webhook request. Refer to the Generating Signatures section above
X-TIMESTAMP	This is the current time in ISO-8601 format. This should be the same timestamp as the one used to generate the Signature

Order Complete Webhook Event List of Fields

Name	Type	Mandatory	Description
reference	String	Y	The `recipientIdentifier` that was sent in the response of the Complete Order Request
externalReference	Number	Y	The `externalReference` that was sent in the Complete Order Request
quantity	Number	Y	The quantity that was sent in the Complete Order Request
recipientIdentifier	String	Y	The `recipientIdentifier` that was sent in the Complete Order Request
email	String	Y	The email that was sent in the Complete Order Request
voucherCodes	Array of VoucherCode	N	If the product in the order is a voucher based product (i.e. it requires voucher codes), then this webhook will return the codes as a list of VoucherCode objects equal to the quantity of VoucherCodes requested for the product
status	String	Y	The status of an order. Possible values: `NEW` `ABANDONED` `CANCELLED` `PENDING` `PARTIALLY_FULFILLED` `SUCCESSFUL` `FAILED` `REFUND` `PARTIAL_REFUND` `CHARGEBACK` `WAITING_WEBHOOK`

VoucherCode Fields

Name	Type	Mandatory	Description
VoucherCode	Array of VoucherCodeProperty	Y	This is a list of `VoucherCodeProperty` objects that make up the voucher code. All `VoucherCodeProperty` objects combined represent one `VoucherCode`.

VoucherCodeProperty Fields

Partners need to assume that VoucherCodeProperty objects will be different per product as each product uses a different set of properties for their codes.

Name	Type	Mandatory	Description
label	String	Y	This is the name of the voucher code property (e.g. `PIN`, `Code`, etc.)
value	String	Y	This is the actual value of the property
type	String	Y	Voucher codes are considered to be dynamic content since these they tend to be different per product This is a field intended for partners that require more structure with the voucher codes by assigning a type to the dynamic content. These are the possible values `CODE` `EXPIRY_DATE` `PIN` `SERIAL_NUMBER` `URL` `OTHER`

Example Order Complete Webhook Payload

{
  "reference": "C-KLJAD1209IOA91123-P",
  "externalReference": "dist_ref_20260723_002",
  "productBundleSku": "CARRY1ST_VAL_10USD",
  "quantity": 1,
  "recipientIdentifier": "[email protected]",
  "email": "[email protected]",
  "voucherCodes": [
    [
      {
        "label": "Card",
        "value": "<real_code_trust_me_bro>",
        "type": "CODE"
      }
    ]
  ],
  "status": "SUCCESSFUL"
}

Configuring Webhooks