Skip to main content

Configuring a webhook

Set up a webhook to receive real-time delivery updates and automate your internal workflows.

Updated this week

You can use webhooks to send real-time delivery and fleet data from NowGo to a configured URL in your own system. This allows you to trigger automated actions, such as updating your internal database, sending custom customer notifications, or tracking driver progress in a third-party application.

When an event occurs in NowGo, such as a job being completed or a driver updating their ETA, NowGo sends a JSON payload using a POST request to your specified URL.


Webhook event types

NowGo supports several event types that you can listen for:

Event type

Event name

Trigger

Shift changes

shift

A shift is created, updated, or deleted.

Job changes

job

A job is modified or assigned.

Stop changes

stop

A stop is added, updated, or removed.

Stop completions

completion

A driver completes a stop in the app.

ETA updates

eta

A driver's location or stop ETA changes.

Driver messages

message

A message is sent from the driver app.

Consignment updates

consignment

Consignment details are modified.

Workflow completions

workflow_completion

A specific delivery workflow is finished.


Set up your webhook

Before you begin, make sure you have a destination URL ready to receive POST requests.

  1. In the NowGo dashboard, click your email address in the top right corner, and select Developers.

  2. Navigate to the Webhook Options tab.

  3. Click Add New.

  4. In the Create webhook configuration page, complete these details:

    • In the Protocol type field, select which protocol to use for the webhook.

    • In the Endpoint field, type the URL to send events to.

    • Optional: If you are using AWS as your protocol, in the AWS field, provide any required AWS authentication information.

    • Optional: If you are using HTTP as your protocol, in the HTTP field, provide any HTTP authorisation headers

    • Optional: If you want to use claim checking, adjust settings in the Claim check section. For more information, see the claim checking section in this article.

    • For each event that you want to send to your webhook, toggle the event on.

  5. Click Create webhook configuration to save your changes, and turn your webhook on.


Claim checking

NowGo can send webhooks directly through AWS SQS (simple queue service), AWS SNS (simple notification service), or Azure Event Hubs. However, some webhook payloads are too large for these channels to process. To manage large data transfers, NowGo uses a claim check pattern. Instead of sending the entire payload through the messaging channel, NowGo can send a unique message ID, referred to as a claim check. Your system then uses this ID to fetch the full message directly from NowGo.

Configuring claim-check settings

You can adjust how claim checking is applied to your webhooks in the Webhook Settings of your NowGo account.

  • Claim check allowed: NowGo only uses a claim check if the message size exceeds the channel's limit. This is the standard setting for most integrations.

  • Claim check all messages: NowGo sends every message as a claim check, regardless of its size. While this requires more work for your system to fetch each payload, it is a more secure method as the full data is never transmitted through the messaging channel.

  • Claim check probability threshold: Use this setting to apply claim checking to a specific percentage of your messages, for example, 10%. This is useful for testing your implementation to ensure it works correctly without requiring you to process all messages using claim check immediately.


Testing and security

  • Test Event: After saving, use the Send Test Event button to verify that your endpoint is correctly receiving the JSON payload.

  • Authentication: We recommend using custom headers to include a secret key or token. This allows your system to verify that the request is legitimately coming from NowGo.

  • Payload Format: All NowGo webhooks use a standard JSON format. For detailed technical specifications on the payload structure for each event type, refer to the NowGo Developer Centre.

Did this answer your question?