Dispatch Module
POST /ext/webhook

register a webhook to get updates from dispatch or ETAs

application/json

Body Required

to register a webhook url

  • webhook string

    webhook url to register. This url must be active and should send back a 200 status code

Responses

  • 204

    Successful operation

  • 401 application/json

    Unauthorized if incorrect api_key is given

    Hide response attributes Show response attributes object
    • error string

      generic information about the error

    • error_desc string

      error information for the developer
  • 400 application/json

    bad request if the url is invalid or will not respond with a 200 status code.

    Hide response attributes Show response attributes object
    • error string

      generic information about the error

    • error_desc string

      error information for the developer
  • 500 application/json

    any other errors from the server

    Hide response attributes Show response attributes object
    • error string

      generic information about the error

    • error_desc string

      error information for the developer
POST /ext/webhook 
curl \
 --request POST 'https://dev.hubz.nyotek.com/ext/webhook' \
 --header "Content-Type: application/json" \
 --data '{"webhook":"https://host.com/webhook"}'
Request examples 
{
  "webhook": "https://host.com/webhook"
}
Response examples (401) 
{
  "error": "generic error",
  "error_desc": "identifier 45 not found"
}
Response examples (400) 
{
  "error": "generic error",
  "error_desc": "identifier 45 not found"
}
Response examples (500) 
{
  "error": "generic error",
  "error_desc": "identifier 45 not found"
}