Skip to main content

[Getting Started - GCW] Setting Up Postback Triggers

Anastasiia Zbrozhek avatar
Written by Anastasiia Zbrozhek
Updated over a week ago

Checklist:

  1. Customer Setup: Ensure the customer is already in the system before creating a postback.

  2. Create a Postback Template:

    • Via Templates Section: Add a new template from the main templates section.

    • Via Customer Profile: Go to the customer's profile, navigate to Triggers, and create the template.

  3. Set Up the Trigger:

    • Add a trigger and name it.

    • Select the event type (e.g., order received, shipped).

    • Choose the delivery method (URL or email).

    • For URL: Enter the URL, set the method to POST, format to JSON, and enable retries if needed.

  4. Configure the Template:

    • Assign a name to the template.

    • Use sample payloads or input custom data.

    • Map input data to the output format using the Template Mapper.

    • Render the output to preview the final data.

  5. Test and Activate:

    • Run a test to ensure proper functioning.

    • Save and activate the template for live notifications.

Once completed, the system will automatically send updates to customers for the selected order events.

Detailed Instructions:

1. Customer Setup

Before setting up a postback, ensure the customer who will receive the notifications is added to your system. This is essential, as the triggers and templates will be linked to their profile.

2. Create a Postback Template

You can create a template in two ways:

Option 1: Through the Templates Section

  • Navigate to the main Templates section.

  • Select "Add Template."

  • Define the template details, such as the name and payload structure.

Option 2: Through the Customer Profile

  • Go to the specific customer’s profile in the system.

  • Select the Triggers tab.

  • Click "Add Trigger" and start creating the template directly.

3. Set Up the Trigger

  • Add a Trigger:

    • Go to the Triggers section within the customer’s profile.

    • Click "Add Trigger" and give it a descriptive name.

  • Select Event Type:

    • Choose the order event that will trigger the notification. Options include:

      • Order received

      • Order failed

      • Order canceled

      • Order returned

      • Order produced

      • Order delivered

      • Order shipped

      • Order in transit

  • Choose Delivery Method:

    • Decide whether the notification will be sent to a URL or an email.

    • For URL delivery:

      • Enter the destination URL.

      • Set the method to POST.

      • Choose JSON as the data format.

      • Enable Retry on Failure if needed to ensure reliable delivery.

4. Configure the Postback Template

If a template has already been created, select it at this step. Otherwise, create a new template:

  • Define Template Name: Assign a meaningful name to the template.

  • Generate the Template:

    • Use the system-provided sample payloads for common events, or define custom payloads.

    • Customize the data based on your needs.

  • Map Input Data:

    • Use the Template Mapper to map the input data fields to the desired output format.

  • Render Output:

    • Preview the final data format to ensure it meets your expectations.

5. Test and Activate the Postback

  • Run a Test:

    • Simulate the trigger to verify that the postback is sent correctly and generates the expected output.

  • Save and Activate:

    • If the test is successful, save the configuration and activate the trigger.

Result:

The system will now automatically send postback notifications to the specified URL or email whenever the selected order event occurs, keeping your customers updated in real time.

More information on how to set up postbacks can be found here.



📝 Not what you needed?

Help us improve this article, send us an email to [email protected] — please include the article title.

Did this answer your question?