To create a new integration, navigate to Webhooks, and click the New Webhook button on the list page to open the multi-step form.
Step 1: Webhook details
First, enter a Webhook Name. We recommend a name that reflects the event type and destination to make it easy to identify later.
Second, you can optionally add a Description. This provides additional context regarding the webhook’s specific purpose.
Step 2: Webhook type & destination
Choose your preferred delivery method. We currently support:
- HTTPS
- SNS
1. HTTPS
Enter your Webhook URL (your destination endpoint).
Then, select your Authentication Type. We support:
- Basic Auth
- Custom
- OAuth
- Token
Each authentication type has its own required fields. For example, basic auth requires a username and password.
You may also configure up to three Custom Headers to be included in the payload. These are optional unless you choose the ‘Custom’ authentication type, where they become required.
2. SNS
If using SNS, provide your Topic ARN.
Step 3: Events
1. Select the event type
Select the specific event you wish to receive notifications for. Please note that only one event type can be chosen per webhook. Supported events include:
- Proof of delivery
- Tracking updates
2. Choose the version
Once an event type is selected, you can choose which version to use. New webhooks default to the latest version.
Versioning allows us to introduce new features without breaking your existing integrations:
- Stability: Current webhooks stay on their original version so your code remains functional.
- Opt-in: Upgrade to newer versions when you are ready for new data structures.
- Testing: Test new formats in staging before moving to production.
Refer to our developer docs for specific version changelogs.
Step 4: Test the Webhook
Before finalising, click Test webhook to verify your configuration.
The test modal offers two options:
-
Blank Form: Sends a dummy payload to verify connectivity.
-
Consignment ID: Sends a real payload test. You can find valid IDs on any manifested shipments overview page on the Connect UI.
Step 5: Create the Webhook
Once satisfied with your test, click Create webhook. You will be returned to the list page where your new webhook will appear at the top of the table.