Create a new company webhook
post/v1/company_webhooks
Request
- Base URLhttps://api.gomotive.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
urlstring
Specify the URL of the Webhook endpoint.
secretstring
Specify the shared secret that will be used to fetch the data. NOTE: Must be 20 characters. If left blank, will be generated automatically.
formatstring
Payload format for the webhook (only json is supported at this time).
actionsstring[]
Specify a list of actions that will be supported by the Webhook.
enabledboolean
Specify if you want to activate this Webhook. Set TRUE to activate. Set FALSE to disable.
Headers
X-Time-Zonestring
Specify the timezone for formatting the timestamps.
X-Metric-Unitsboolean
Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units
X-User-Idinteger
Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.
Response
201
Example response
{
"company_webhook": {
"id": 27,
"url": "https://api.gomotive.com/callbacktest/bd0421",
"secret": "67298a4636cb6e07ceabf750bb63e99d",
"format": "json",
"actions": [
"vehicle_location_updated"
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.