⭐Connect to Webhook

Chup Online provides a versatile feature that allows users to create and configure webhooks, a tool designed to deliver prompt and real-time notifications for a variety of events taking place within the Chup Online platform. This functionality can be accessed and set up in two ways: firstly, through a designated section specifically for this purpose on the API & Webhooks Settings page, and secondly, by utilizing the API directly.

This flexibility ensures that users can choose the most convenient method for their needs. Furthermore, for each webhook, there is an option to tailor the notifications received. Users can select to be alerted about all events that occur on the platform or they can opt to receive updates for only specific events.

Additionally, there is the ability to specify the particular locations for which these notifications are relevant. This level of customization ensures that users receive only the most pertinent information, tailored to their specific requirements and interests within the Chup Online platform.

Configuring Webhooks within Chup Online

Step 1: Authorization

• Ensure you have the bearer token ready, obtained as described in the "Get Started" guide.

Step 2: Create Webhook Configuration [link]

• Construct a JSON payload that specifies the details of the webhook. This will include the type (incoming or outgoing), and any other relevant settings.

{
    "enable" : 1,
    "incoming_url" : "https://webhook.site/63f9e0fb-b990-4e5e-b847-xxxxxx",
    "enable_incoming" : true,
    "outgoing_url" : "https://webhook.site/63f9e0fb-b990-4e5e-b847-xxxxxx",
    "secret_key" : "abcdxyz*****",
    "enable_outgoing" : true
}

Step 3: Handle the Response

• On success, the Chup Online API will return details of the created webhook, including an identifier that can be used for future updates or deletions.

• If the request fails, handle the error accordingly by checking the error message and status code.

Step 4: Verify Webhook Setup

• To ensure that the webhook has been set up correctly, you can make a GET request to list all configured webhooks or to retrieve the details of the specific webhook by its ID.

By following these steps, you can integrate webhooks into your applications, enabling seamless data synchronization between Chup Online and your systems.

Testing Webhook During Development

During the development phase of webhooks, after selecting the event types you wish to monitor, you can conduct preliminary tests by initiating simulated HTTP requests to your app. For this purpose, you might opt for a command-line utility such as curl or a graphical tool like Postman.

Should you not be prepared to create an endpoint in your system but still desire to observe webhook responses for certain trial events, consider using a platform like RequestBin. It provides a temporary endpoint URL which allows you to collect and inspect the HTTP requests dispatched by the activated webhooks.