This article explains how to set up postback notifications for order events, such as orders received, failed, canceled, returned, produced, delivered, shipped, or in transit. By configuring postbacks, you can automatically send notifications to customers about the progress of their orders.
Setting Up Postback Notifications for Order Events
To set up postback notifications, follow these steps:
Step 1: Customer Setup
Before creating a postback, make sure the customer who will receive the notifications is already in the system.
Step 2: Creating a Postback Template
You can create a postback template in two ways:
Through the Templates Section: Add a new template from the main templates section.
Through the Customer Profile: Navigate to a specific customer’s profile, go to Triggers, select Add Trigger, and create the template directly from there.
This guide will walk you through creating a template through the customer profile.
Step 3: Setting Up the Trigger
To set up the trigger:
Add a Trigger: Go to the customer's profile, select Add Trigger, and give the trigger a name.
Select Event Type: Choose the event that will trigger the postback. Options include:
Order received
Failed
Canceled
Returned
Produced
Delivered
Shipped
In transit
Choose Delivery Method: Select whether to send the postback to a URL or email. For this example, we’ll use a URL.
Enter URL and Setup Method:
Enter the URL to which you’ll send the event data.
Select the POST method and set the format to JSON.
Enable Retry on Failure if you want the system to retry sending the postback if a failure occurs.
Step 4: Configuring the Postback Template
If a template is already created, you can select it here. Otherwise, create a new one.
Define Template Name: Assign a name to the template.
Generate the Template:
The system provides sample payloads for different events. You can also input custom data.
Map Input Data: Use the Template Mapper to define how input data maps to the output format. Gelato can provide template mappers if needed. You can also create custom mappings.
Render Output: After mapping, render the data to view the final output, which is what will be sent in the postback.
Step 5: Testing and Activating the Postback
Run a Test: Once the template is configured, run a test to ensure that the postback sends correctly and generates the expected output.
Save and Activate: If the test is successful, save the template and activate the trigger.
After completing these steps, the system will send a postback to the designated URL with the relevant order information every time the specified order event occurs.
Customer Support
If you need any support or would like to share feedback, contact us at [email protected]