API Reference
Log In

Create a new company Webhook

post
https://api.gomotive.com/v1/company_webhooks

Purpose: Use this endpoint to create a new company Webhook.

📘

NOTE

You must specify the following are Query Parameters:

  • URL
  • Secret
  • Format
  • Actions
  • Enabled

Refer to the Query Parameters section for more info.

Response Parameters

id

  • Type: Integer
  • Description: The unique identifier for the webhook.

url

  • Type: String
  • Description: The URL to which the Webhook sends data.

secret

  • Type: String
  • Description: A secret key used for Webhook authentication.

format

  • Type: String
  • Description: The format of the Webhook data (e.g., json).

actions

  • Type: Array of Strings
  • Description: The list of actions that trigger the Webhook.

enabled

  • Type: Boolean
  • Description: Indicates whether the Webhook is enabled.
Query Params
string

Specify the URL of the Webhook endpoint.

string

Specify the shared secret that will be used to fetch the data. NOTE: Must be 20 characters. If left blank, will be generated automatically.

string

Payload format for the webhook (only json is supported at this time).

actions
array of strings

Specify a list of actions that will be supported by the Webhook.

actions
boolean

Specify if you want to activate this Webhook. Set TRUE to activate. Set FALSE to disable.

Headers
string

Specify the timezone for formatting the timestamps.

boolean

Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units

int32

Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.

Responses

Updated about 1 year ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 year ago