Webhooks

Webhooks are an advanced feature that allow organizations to be notified as soon as special trigger conditions are met, via an HTTP POST to the URL specified. Complete webhook documentation, including triggers and descriptions, can be found here.

webhooks.gif

Manage or create webhooks from the Onfleet Dashboard, by logging in as the admin user and navigating to the API & Webhooks tab in Settings

To create a new webhook:

  1. Click the + button under Webhooks
  2. (optional) Label the webhook with a distinctive name
  3. Choose from one of 13 webhook triggers:
    • Task started
    • Driver ETA less than or equal to X seconds
    • Driver arriving, at or closer than X meters
    • Task completed
    • Task failed
    • Driver status changed
    • New task created
    • Task updated
    • Task deleted
    • Task assigned
    • Task unassigned
    • Task delay time is greater than or equal to X seconds
    • Task cloned
  4. Enter the URL where webhooks updates should be pushed
  5. Validate and create the webhook

Validation

To ensure ownership of the URL used, Onfleet requires validation before the webhook is enabled. 

The URL value provided will receive a GET request from our servers, with a check query parameter. You need to respond to our validation request with exactly this value, untouched, as a simple string response. See the Create a Webhook documentation for code examples.

Note: Zapier and RequestBin URLs are whitelisted and are automatically validated.