Create new webhook subscription.

Create a new webhook subscription.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A webhook subscription provides a process of posting to a user's endpoint when an event is triggered.

string
required

Name of the webhook subscription.

string
enum
required

Topic of the webhook subscription.

optimizationSolution : get notified about the optimization solutions generated by Interplai API. The supported actions include create, and all.

log : get notified about important events of Interplai API services.

trip : get notified about the trips generated by Interplai API. The supported actions include create, update, delete, pickup, dropoff, cancel, abort and all.

route : get notified about the routes generated by Interplai API. The supported actions include accept, reject, and all.

segment : get notified about the segments generated by Interplai API. The supported actions include accept, reject, and all.

waypoint : get notified about the waypoints generated by Interplai API. The supported actions include create, update, arrive, depart, and all.

vehicle : get notified about the vehicles generated by Interplai API. The supported actions include create, update, delete, and all.

location : get notified about the locations generated by Interplai API. The supported actions include create, update, delete, and all.

chatMessage : get notified about the messages from driver. The supported actions include createCustomer, createAgent, and createPartner.

requestForQuote : get notified about the request for quotes generated by Interplai API. The supported actions include create, and all.

quote : get notified about the quotes generated by Interplai API. The supported actions include create, accept, reject and all.

action
array of strings
required

The action that is currently being performed.

action*
uri
required

URL that the web service will post back to when the event is triggered.

string

Optional API key that the web service may use for authentication to the user's server. The API key will be embedded in the post as a custom header 'x-api-key'.

Responses

Callbacks
Language
Credentials
Header
LoadingLoading…
Click Try It! to start a request and see the response here! Or choose an example:
application/json