Telgoo5 has introduced web-hooks which allows Telgoo5 to send real-time updates from Telgoo5 to your internal system whenever certain events occur.

These updates are useful in situations when you want Telgoo5 to send real-time updates regarding payments, activations, etc to your system.

Once your system receives these updates you can use them for various actions like updating a database, sending notifications, or initiating further workflows.

Key Concepts:

• Triggering Event: Webhooks are activated by specific actions or events in the system.
• URL Endpoint: When an event occurs, the source system sends a request to a pre-configured URL (the webhook URL) in the target system, which listens for these events.
• Payload: The data included with the request, typically in JSON format, is called the payload. It contains information about the event that triggered the webhook.

Steps to Configure a Webhook:

1. Ensure the Integrations permissions is enabled by going to User Settings (PC480), miscellaneous permissions, and selecting Integrations (PC1143). 

2.  Navigate to Settings > Integrations (PC1143) > Webhook.

Go to Settings > Integrations (PC1143) > Webhook > Manage.

How Webhooks Work:

1. Event Occurs: An event takes place in the source system.
2. Webhook Triggered: The source system detects the event and sends a request to the webhook URL.
3. Payload Sent: The webhook sends the event's details (e.g., user information) to the target system’s URL.
4. Receiving System: The target system processes the data, which could result in actions like updating a database, sending notifications, or initiating further workflows.
5. Response: The target system returns a response indicating the webhook was processed successfully.

Authentication and Response Setup:

• No Authentication: Select this option if no authentication is required. Choose the fields you want in the response. Click the "View Sample Response" button to see the expected response in JSON format.

• Basic Authentication: If Basic Authentication is required, enter a username and password, and select the fields you need in the response. You can preview the response by clicking the "View Sample Response" button.

The “View sample response” button allows us to view the response that we want in JSON format.

Repeat the same process for other events as well for which you want to setup webhooks.

Once the configuration is complete, click the Submit button to save changes, or Cancel to discard them.

.