Exim Webhook Integration

This guide will walk you through the steps required to set up a webhook for receiving shipment tracking updates. Follow these steps to configure your webhook:

Step 1: Add Webhook Name

The webhook name is used to identify your webhook configuration. Choose a name that clearly indicates the purpose of the webhook.

Instructions:

1. Enter a descriptive name in the "Webhook Name" field.

2. Example: "ShipmentTrackingUpdates"

Step 2: Webhook URL

The webhook URL is the endpoint where the tracking updates will be sent. This should be a URL on your server that can process incoming requests.

Instructions:

1. Enter the URL of your endpoint in the "Webhook URL" field.

2. Ensure that your server is configured to handle incoming requests at this URL.

3. Example: "https://yourdomain.com/webhooks/shipment-updates"

Step 3: Select Request Type

The request type specifies how the data will be sent to your webhook URL. You can choose either POST or GET. POST is recommended as it supports sending larger amounts of data securely.

Instructions:

1. Select either POST or GET from the "Request Type" dropdown menu.

2. Recommended: POST

Step 4: Select Events

Events are specific triggers that will cause the webhook to send data. You need to select which events you want to receive updates for.

Instructions:

1. Check the boxes next to the events you want to receive updates for.

2. Example: Select ["ShipmentCreated", "ShipmentUpdated", "ShipmentDelivered"]

Step 5: Add Your Header as an Object

Headers are key-value pairs that provide additional context about the request. If your endpoint requires authentication or specific headers, you can add them here.

Instructions:

1. Enter the headers as a JSON object in the "Headers" field.

2. Example:

   json

   Copy code

   { "Content-Type": "application/json", "Authorization": "Bearer YOUR_API_TOKEN" }

Example Configuration

Here’s an example of how your configuration might look when completed:

Copy code

{ "webhookName": "ShipmentTrackingUpdates", "webhookUrl": "https://yourdomain.com/webhooks/shipment-updates", "requestType": "POST", "events": ["ShipmentCreated", "ShipmentUpdated", "ShipmentDelivered"], "headers": { "Content-Type": "application/json", "Authorization": "Bearer YOUR_API_TOKEN" } }

Detailed Instructions:

1. Log into the Application:

   • Access the product where you will be setting up the webhook.

2. Navigate to Webhook Settings:

   • Locate the section in the application where webhooks can be configured. This is typically found under settings or integrations.

3. Enter Webhook Name:

   • In the "Webhook Name" field, enter "ShipmentTrackingUpdates" or any descriptive name that indicates the webhook's purpose.

4. Enter Webhook URL:

   • In the "Webhook URL" field, input "https://yourdomain.com/webhooks/shipment-updates". Make sure your server is set up to handle requests at this URL.

5. Select Request Type:

   • From the "Request Type" dropdown, choose POST.

6. Select Events:

   • Check the boxes for ["ShipmentCreated", "ShipmentUpdated", "ShipmentDelivered"] or any other events you want to track.

7. Add Headers:

   • In the "Headers" field, enter the following JSON object:

     json

     Copy code

     { "Content-Type": "application/json", "Authorization": "Bearer YOUR_API_TOKEN" }

   • Replace "YOUR_API_TOKEN" with your actual API token.

8. Save Configuration:

   • Review your settings and click the "Save" button to apply the configuration.