Create a transaction webhook

Steps

1. 1

   Go to the Integrations section of your store’s administration.

2. 2

   Enable the JSON Webhooks checkbox within the “Webhooks Next” section.

3. 3

   Enter a name to identify the webhook, and the URL of the endpoint that will receive the payload.

4. 4

   An encryption key is set automatically. To use your own, click Show secret and enter your own secure key.

5. 5

   Choose the resource you want this webhook to subscribe to — see Webhook events reference for the available resource types and their events. Each webhook subscribes to one resource type, and this can’t be changed later — to switch resources, delete the webhook and create a new one.

6. 6

   Click Update Webhooks Next to save.

Saving sends a GET request to your endpoint to confirm the URL is valid. Your endpoint must be able to accept GET requests for the save to complete.

Notes

• All events for the subscribed resource are sent to your endpoint — filter for the specific events you care about rather than assuming only one event type will ever arrive. You can confirm which event triggered a given payload using the Foxy-Webhook-Event header.

• If you sell subscriptions: subscriptions can start in the future, resulting in a $0 initial transaction, and subscription modifications can also result in $0 transactions. Account for this in your endpoint logic.