This article explains how to configure webhooks using the Gelato API to receive notifications in your application whenever an event occurs with your order.
Webhook Configuration
The Gelato API offers robust webhook functionality, allowing you to stay informed about critical events related to your orders. To configure your webhooks, follow these steps:
Access the Gelato Dashboard and navigate to the Webhooks section. This dedicated area provides a centralized hub for managing your webhook configurations.
Click on the "Add Webhook" button to initiate the creation of a new webhook. This action will present you with a configuration form where you can specify the details of your webhook.
Provide the URL of the endpoint in your application that will receive the webhook notifications. Ensure that this URL is publicly accessible and properly configured to handle incoming HTTP requests. Select the HTTP method, either GET or POST, that aligns with your application's requirements. Choose the specific event types you want to subscribe to. Gelato offers a comprehensive list of event types, such as order creation, order updates, and shipment notifications, providing granular control over the notifications you receive. For detailed descriptions of each event type, refer to the API Documentation.
Set up authorization for your webhook to enhance security and ensure that the notifications originate from a trusted source. Select the appropriate authorization type, such as HTTP headers or query parameters. Provide the necessary credentials, such as an API key or token, in the designated fields. To confirm your webhook configuration and ensure that notifications are delivered successfully, send a test notification to the specified endpoint. This step helps identify and resolve any potential issues before the webhook is deployed to a live environment.
Managing Webhooks
Once you have configured your webhooks, you can easily manage them from the Gelato Dashboard. The Webhooks section provides a comprehensive overview of all your webhooks, allowing you to perform actions such as:
Editing existing webhooks: Modify the configuration of your webhooks at any time to align with your evolving needs. Update the notification URL, event subscriptions, or authorization details as required.
Deleting webhooks: Remove webhooks that are no longer needed to maintain a clean and organized webhook configuration. Deleting a webhook will stop notifications from being sent to the associated endpoint.
For a deeper understanding of the Gelato API, including detailed information on webhook events and payloads, please refer to our comprehensive technical documentation.
To access the Webhooks section in your Gelato account, you can directly go to Developer > Webooks from the left menu.