Subscription Webhooks Settings

It is possible to configure webhooks to synchronize subscription data between Guru and external applications. This feature can be used to send data to your own app or system.

In Guru, you can add webhooks and adjust the sending rules, ensuring that subscription data is transmitted securely, standardized, and according to the needs of your external system.

On this page:

Webhooks for a subscription
Add subscription webhook

Before you start, you need…

To be an administrator user or have permission to perform the following actions.

Webhooks for a Subscription

You can use the subscription webhook (recurring charges) to receive a notification in the destination system every time the subscription is updated and meets the conditions configured in the webhook.

This function is useful when you need to take an action¹ according to the subscription status in question, for example: when the subscription is activated, it is necessary to release the customer's access in your application.

Below you will find the list of subscription webhook sending types (triggers):

Type	Sent when…
Active	The subscription has been updated and has the status `active`.
Canceled	The subscription has been updated and has the status `canceled`.
Card Change	The subscription payment method has been updated.
Expired	The subscription has been updated and has the status `expired`.
Inactive	The subscription has been updated and has the status `inactive`.
Overdue	The subscription has been updated and has the status `overdue`.
Started	The subscription has been updated and has the status `started`.
Trial	The subscription has been updated and has the status `trial` (free trial).

(1) The Guru webhook only sends subscription information. The destination system or application is responsible for interpreting and taking the necessary actions according to the information received in the post.

Add Subscription Webhook

You can configure webhooks in the Guru admin through the following operations: add, update, deactivate, and remove. All actions performed are registered by the platform and can be consulted in the Audit.section.

Check the integration limit¹ active (category webhooks) for the contracted plan. If you have reached the available limit, simply upgrade to the Plus 2 or Plus 3 category.

(1) During the testing period, a maximum of 2 active webhooks are allowed.

Steps:

1 - Access the Guru admin with your username and password.

2 - In the side menu, click on Settings and then, Webhooks.

3 - In Webhooks, click on Subscriptions.

4 - In the upper right corner, click on Add Webhook.

5 - Fill in the information:

Basic Data

Name: name of your webhook;
URL: destination URL obtained from the system in question (or from the responsible developer).

Sending Rules:

Concurrent Requests: maximum number of concurrent requests that Guru should perform - indicate an appropriate value to avoid overloading the destination server;
Status: for which subscription statuses the webhook should be sent - you can select more than one.

For example: if you configure the webhook for 5 simultaneous sends, if 6 simultaneous sends are made, the sixth send is placed in a waiting queue with a delay (delay) of 10 seconds.

Webhook sending funnel:

Destination URL + object ID (transaction or subscription) -> maximum of one webhook at a time;
Destination URL -> maximum number of simultaneous webhooks configured.

Record Filtering

Filter by: check filter by all, Marketplaces or Products⁽¹⁾;
Active: switch the button to the on position.

^{(1) When choosing to filter by “all” or “marketplaces”, any new product created will be automatically associated with the webhook.}

If you filter by Marketplaces or All, whenever you create a new product that meets the requirements, it will be associated with the corresponding webhooks.

Only subscriptions that meet the indicated filtering criteria will be sent by the webhook.

6 - Click on Send.

From this moment on, each updated subscription that meets the defined criteria will be sent to the Destination URL.