What is a Webhook

Vrio offers comprehensive support for webhooks. While they may seem complex initially, webhooks are incredibly powerful tools. Essentially, webhooks function like notifications. At their core, they deliver a payload of data representing a single record that has been created or updated.

Webhooks in Vrio

With a webhook in Vrio, you can trigger an HTTP POST callback to a configured URL when a specific event occurs within your Vrio environment. The callback payload will contain useful data related to the event. With this data, webhooks can be used to build custom integrations, notifications, and automate other workflows.

📘

Campaign Restrictions Available

For certain use cases it may be beneficial to limit a webhook to a specific Campaign(s).

Vrio treats webhooks as events updated around:

Orders: Order is Updated or Abandoned.

Transaction: Transaction is Completed, Skipped or Unskipped.

Order Offer: Order Offer is Updated or Cancelled.

Shipment: Shipment is Shipped, Cancelled or Fulfilled.

See specific webhook examples here.

📘

Note

Enterprise users can request custom webhooks. These webhooks are built to specification including payload, limits and reattempts on failure.

Common webhook use cases

There are various scenarios where webhooks can be useful, some of them include:

• Posting order information to a proprietary fulfillment system
• Updating digital subscription access with cancellations and reactivations
• Populating an external database for internal reporting needs

Setting up a Webhook in Vrio

You must be an administrator or have permissions granted to your user to create a webhook.

1. In the menu, go to Settings > Add New Connection > Other
2. Click "Connect Now" under Webhook

Vrio supports individual URL destinations for:

1. Order URL
2. Transaction URL
3. Order Offer URL
4. Shipment URL

Within the Webhook connection you can also limit the webhooks to specific Campaigns.

Webhook URLs

Once you have a payload, you need somewhere to send it. Usually its to a special URL where a server is waiting to interpret the payload and do something with it. This is a server you control

Once you have the URL, you'll be able to add it to the webhook connection you just created. After you do that, you should start receiving payloads whenever an event happens.

FAQ

Q: How often do webhooks trigger?

A: Every 5 mins