Webhook events and payloads
Learn about when each webhook event occurs and what the payload contains.
You can create webhooks that subscribe to the events listed on this page. Each webhook event on this page includes a description of the webhook properties for that event. If the event has multiple actions, the properties corresponding to each action are included. For more information, see "Creating webhooks."
Note: Payloads are capped at 25 MB. If an event generates a larger payload, Shopwaive will not deliver a payload for that webhook event. We suggest monitoring your payload size to ensure delivery.
HTTP POST payloads that are delivered to your webhook's configured URL endpoint will contain several special headers:
X-Shopwaive-Hook-ID
: The unique identifier of the webhook.X-Shopwaive-Event
: The name of the event that triggered the delivery.X-Shopwaive-Delivery
: A globally unique identifier (GUID) to identify the delivery.X-Shopwaive-Signature-256
: This header is sent if the webhook is configured with asecret
. This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and thesecret
as the HMACkey
. For more information, see "Validating webhook deliveries."X-Shopwaive-Hook-Installation-Target-Type
: The type of resource where the webhook was created.X-Shopwaive-Hook-Installation-Target-ID
: The unique identifier of the resource where the webhook was created.
To see what each header might look like in a webhook payload, see "Example webhook delivery."
Following is an example of a webhook POST
request that uses the JSON format.
Events (i.e. subscription topics) are permission-controlled Shopwaive resources that can be shared with external sites or applications using webhooks, which deliver payloads at a url that you define. Payloads are delivered when you have an active subscription and an event action (i.e. event trigger) occurs for that resource.
This event occurs when there is activity relating to a customer's available balance. For information about the APIs to manage a customer's available balance, see Customer API in the REST API documentation.
To subscribe to this event, a Shopwaive App must have at least read-level access for the "Available balance" organization permission.
Availability for available_balance
available_balance
Organizations
Shopwaive Apps
Webhook payload object for available_balance
available_balance
Action type: deleted, adjusted, redeemed, or created
An available balance was <action-type> for a customer.
Webhook request body parameters
Last updated