Find answers to frequently asked questions and problems related to sending webhooks.
On this page:
-
How does the webhook work?
-
What are simultaneous sends and how to configure them correctly?
-
My number of recent sales exceeded the maximum number of simultaneous sends configured, what happens in this case?
-
I have my own system, can I receive Guru's webhooks?
-
Can I send the webhook to automation tools like Zapier and similar?
-
Why can't I add or activate a webhook?
-
The webhook has not been sent yet, what happened?
-
The webhook was sent, but the data does not appear in the destination system. What should I do?
How does the webhook work?
The webhook is a feature that automatically sends notifications to an external system every time a specific event occurs. In Guru, you can send sales, subscription, or e-ticket notifications.
When your account has active webhooks and the webhook sending condition is met, Guru sends a notification to the configured destination address containing the data of the respective sale, subscription, or e-tickets.
The sends go to a queue and, in a few minutes, reach the destination system. The sending history is recorded in the audit of the respective sale, subscription, or e-tickets for future reference.
What are simultaneous sends and how to configure them correctly?
Simultaneous sends indicate the maximum number of sends that Guru can make to an external system at the same time. This feature is useful to avoid overloading the destination server with too many requests at once.
How it works in practice
For example: let's say you configured a maximum of 10 simultaneous sends and are in the middle of a launch with many sales happening at the same time. In this case, the system will behave as follows:
-
Retrieves and sends the next 10 sales* from the list all at once to the destination server.
-
If there are still items in the queue to send: waits 10 seconds and executes step 1 again.
(*) Instead of 10 sales, it can be 10 subscriptions.
How to configure correctly
By default, we recommend configuring 5 simultaneous sends.
The greater your server's capacity, the greater the number of simultaneous sends you can configure. Be cautious with this limit, as a high number of simultaneous sends can lead to webhook sending errors (HTTP 500, 502, or 503 responses from the destination server).
When in doubt, talk to your infrastructure specialist to find out the appropriate number of simultaneous sends you should configure for subscriptions, e-tickets and sales.
If you have active sales, subscription, or e-ticket webhooks for the same destination address, pay extra attention to the maximum number of sends configured for each webhook. A launch involving sending these 2 webhooks at the same time can quickly overload your server.
My number of recent sales exceeded the maximum number of simultaneous sends configured, what happens in this case?
In this case, your sending queue will be split into smaller blocks according to the maximum number of simultaneous sends configured. Each block will be sent with a 10-second interval between them.
Example: let's say you have 55 pending sales to send and your maximum number of requests is 10 sends. In this case, Guru will organize the sending of webhooks into 6 blocks. The sends will be as follows:
-
Block 1: sends 10 sales, waits 10 seconds;
-
Block 2: sends +10 sales, waits 10 seconds;
-
Block 3: sends +10 sales, waits 10 seconds;
-
Block 4: sends +10 sales, waits 10 seconds;
-
Block 5: sends +10 sales, waits 10 seconds;
-
Block 6: sends the remaining 5 sales.
I have my own system, can I receive Guru's webhooks?
Yes, you can. For this, you will need the help of a developer to build a web system capable of receiving the webhook, reading the post content, and then saving or updating your database.
Share this documentation with your developer.
Can I send the webhook to automation tools like Zapier and similar?
Yes, you can. However, you should keep in mind that these tools do not usually store the received content in a database.
Since the webhook is triggered every time a sale, subscription, or e-ticket is updated in the system (even without data changes), you run the risk of triggering the same action multiple times for the same sale, subscription, or e-ticket when using these tools.
Ideally , the destination tool should perform basic control of received notifications to take actions only when it is a new item or when there is a change in specific data.
Why can't I add or activate a webhook?
Each plan has a maximum limit of active webhooks.
If you are in the trial period, you are allowed to activate up to 2 webhooks. If you are already a subscriber, you may need to upgrade to the Plus 2 or Plus 3 category.
Consult the operational limits of each plan at this link.
The webhook has not been sent yet, what happened?
If you are in the middle of a launch and there was a very high volume of sales, they may still be in the sending queue. If you are not in a launch, Guru's sending queue may be temporarily overloaded.
Wait at least 30 minutes and check the audit of the respective sale, subscription or e-ticket to see if the send was completed. If the problem persists, contact our support team.
The webhook was sent, but the data does not appear in the destination system. What should I do?
The destination system is responsible for processing and locally registering the webhook sent by Guru.
Guru sends the notification to the destination platform minutes after the corresponding sale, subscription, or e-tickets is updated. In some cases, data may take a little longer to appear in the destination system due to server overload.
If the sent data does not appear in the destination system within 30 minutes, follow these procedures:
1 - Check the webhook sending result
In the detail of the sale, subscription or e-tickets corresponding, access the option Audit and look for a recent item1 that indicates a webhook send to the destination platform. According to the processing result of the send, the displayed icon can be blue (success) or red (error).
1 Audit events are listed from most recent to oldest.
1.1 - Send completed successfully
In this case, the destination system may be experiencing some server instability and the processing of notifications received from Guru was impacted. Wait at least 30 minutes and consult the system again to see if the situation has normalized.
If after 30 minutes the sales, subscription, or e-ticket data does not appear in the destination system, contact the support of that tool to verify why the data sent by Guru is not yet being displayed.
1.2 - There was an error in sending
In this case, you should click on the audit and check what error is described. Most of the time, the displayed error is returned by the destination system. Try to analyze the error1 returned to identify which support (Guru or destination system) you should contact.
If the displayed error is an HTTP 500, 502, or 503 code, it may mean that the server is overloaded. In this case, check the number of simultaneous sends configured or contact the support of the destination tool to find out what happened.
1 The description of the error returned by the destination platform is displayed in the JSON field. In some cases, this message may be in English. Copy the content and use a translator if necessary.
More Resources