Developers

Webhooks

Introduction

Webhooks are a powerful tool that enables real-time updates to your integration. By subscribing to specific events, you can receive HTTP POST requests containing relevant data whenever these events occur. This allows you to automate responses and streamline your processes, reducing manual intervention and improving overall efficiency.

Managing Webhooks

Our platform provides a user-friendly visual interface to manage your webhook subscriptions. To set up and monitor your webhooks:
  1. Navigate to Settings by clicking on the gear icon in the top right corner of the navigation bar.
    Preview
    Webhooks 03
  2. In the Settings menu, locate the API section in the bottom left corner and click on the Subscriptions tab.
    Preview
    Webhooks 02
  3. Click on the Create a Subscription button to create a new webhook subscription.
    Preview
    Webhooks 01
  4. Fill in the required details, such as the event type and the URL where you want to receive the webhook notifications. Once you've provided the necessary information, click on the Create button. Your new subscription will now be listed in the Subscriptions tab.
    Preview
    Webhooks 00
Please note that webhooks cannot currently be managed via the API and must be set up through the Giftogram application platform.

Supported Webhook Events

Our platform currently supports the following webhook events:
WebhookDescription
order.createdTriggered when a new order is successfully initiated on the platform. Includes pertinent information such as created date, order details, and associated customer or recipient details.
campaign.createdFired when a new campaign is created in the system. Provides important details such as campaign name, ID, funding information, creation date, creator, and more.
campaign.deletedActivated when an existing campaign is deleted from the system. Sends information such as the ID of the campaign that was removed and the time of deletion.
account.fundedTriggered when funds are added to your platform account. Notes amount added for the relevant account.

Security Considerations

To ensure the security of your webhook data, it is strongly recommended that you use HTTPS-secured endpoints to receive webhook notifications. This helps protect sensitive information transmitted between our platform and your system.
By leveraging webhooks, you can create a more responsive and automated integration with our platform. Stay informed about important events and take immediate action based on the real-time notifications delivered to your designated endpoints.