Skip to main content

Webhooks - Retrieve All Webhooks

Overview​

This endpoint allows you to list all webhooks for a given account.

Request​

GET /v1/accounts/{account_uuid}/webhooks​

Example Request​

GET /v1/accounts/3584a197b5a9/webhooks

Response​

Response Values​

Please see the example response documented below. The webhook object is documented within the 'Model' folder of this section.

Example Response​

[
  {
    "uuid": "DPTCye18PXXAG2gv",
    "url": "http://example.com/webhooks",
    "secret_token": "SuperSecretToken123",
    "enabled": true,
    "events": {
      "driver_location_updated": true,
      "order_status_updated": true,
      "driver_eta_updated": true,
      "order_assigned": true,
      "order_unassigned": true,
      "delivery_status_updated": true,
      "item_status_updated": {
        "suggested": false,
        "being_prepared": false,
        "prepared": false
      },
      "analytics_report_ready": true,
      "driver_shift_updated": true,
      "order_preparation_updated": {
        "suggested": false,
        "being_prepared": false,
        "prepared": false
      },
      "order_kds_print_request": false
    },
    "options": {
      "skip_unassigned_if_assigned_to_other_task_group": true
    }
  },
  {
    "uuid": "r1Q9PFRTuC9FbGCA",
    "url":  "http://example.com/item_and_order_preparation_updated",
    "secret_token": "SuperSecretToken123",
    "enabled": true,
    "events": {
      "driver_location_updated": false,
      "order_status_updated": false,
      "driver_eta_updated": false,
      "order_assigned": false,
      "order_unassigned": false,
      "delivery_status_updated": false,
      "item_status_updated": {
        "suggested": true,
        "being_prepared": true,
        "prepared": true
      },
      "analytics_report_ready": false,
      "driver_shift_updated": false,
      "order_preparation_updated": {
        "suggested": false,
        "being_prepared": true,
        "prepared": false
      },
      "order_kds_print_request": false
    },
    "options": {
      "skip_unassigned_if_assigned_to_other_task_group": false
    }
  }
]