API Reference

Setting Up Webhooks

Webhooks are HTTP callbacks processed and sent by Loop to a pre-defined URL. They allow your application to receive information from Loop without having to reach out to Loop with an API call. Each webhook has a topic, which defines the information payload, and a trigger, which determines the event which triggers the request to be sent from Loop.

Loop offers five webhook topics and eight triggers.

Topics:

  • Return
  • Label
  • Restock
  • Giftcard
  • Happy Returns shipment

Triggers:

  • Return updated: A return has been updated (e.g. state has changed from open to closed).
  • Return created: A new return was submitted in the Returns Portal.
  • Return closed: A return's state has been updated to closed.
  • Label created: A shipping label has been created via EasyPost (or other shipping service) .
  • Label updated: A shipping label has been updated (e.g. status has changed from new to in transit).
  • Restock requested: An item in the return has been restocked in Shopify.
  • Giftcard requested: A gift card has been requested as part of an exchange.
  • Shipment processed: A Happy Returns shipment has been processed.

To set up webhooks, go to the Developers page in the Loop admin or your sandbox account. There, you can create a webhook, select a topic and trigger for the webhook, and define the URL the payload will be sent to.

Webhooks can have one of the following statuses:

  • Inactive: Manually deactivated by a user
  • Active: Webhook is operating normally

Loop webhook tips

Webhook topics and triggers can be combined to suit your desired outcome. There are also certain combinations that will not yield results. (For example, If you set up a webhook with a topic of Label and a trigger of Return create, there will be no payload available, as a return needs to be created before a label is generated.)

Webhooks will not retry in the event of a failure response.

If you wish to see the information payload of a webhook before incorporating the webhook into your code, the webpage webhook.site provides you with a URL to use in the webhook and display the information you receive on their page, allowing you to examine the JSON structure of the payload when the webhook is fired (even as a test). Later on, you can change the webhook URL for production use.

If you need additional support regarding webhooks, please contact Loop's support team.