simulator

register a new event-triggered webhook

Changed on
post/simulator/webhooks

Request

  • Base URL
    http://localhost:8086
  • URL
    http://localhost:8086/simulator/webhooks
  • Auth
    HTTP bearer

Request body

webhooksstring[] required
notificationUrlstring uri required

Example request

{
  "webhooks": [
    "automation_level_changed",
    "driver_changed",
    "journey_begin",
    "journey_end",
    "location_changed",
    "ignition_changed",
    "harsh_acceleration",
    "harsh_braking"
  ],
  "notificationUrl": "https://myserver/endpoint"
}

Response

Webhook registered

subscriptionIdstring uuid required

Example response

{
  "subscriptionId": "3701fac0-391b-4ad7-8392-8cba1ae5feca"
}

Changes

  • c420a5f456eaRevision changes
    • info

      added the non-success response with the status

  • 4c1c8b98a933Revision changes
    • info

      added the new automation_level_changed enum value to the request property /

    • info

      added the new driver_changed enum value to the request property /