Fetch all the Webhook requests

Log in to see full request history

Purpose: Use this API to list all the Webhook requests that are available at your company.

Response Parameters

id

  • Type: Integer
  • Description: The unique identifier for the Webhook request.

company_webhook_id

  • Type: Integer
  • Description: The unique identifier for the associated Webhook.

company_webhook_request.action

  • Type: String
  • Description: The action that triggered the Webhook request.

url

  • Type: String
  • Description: The URL to which the Webhook request was sent.

secret

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

format

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

payload

  • Type: Object
  • Description: The payload data sent with the Webhook request.

response_code

  • Type: Integer
  • Description: The HTTP response code received after the request was sent.

num_failures

  • Type: Integer
  • Description: The number of times the Webhook request failed.

posted_at

  • Type: String (ISO 8601 datetime format)
  • Description: The date and time when the Webhook request was sent.

Query Params
int32

Specify the ID of the Webhook that you want to view.

string

Specify the action type of the Webhook request.

int32

Specify the response code that you receive on the Webhook delivery.

date

Specify the date after which the Webhook was posted.

date

Specify the date before which the Webhook was posted.

string
Defaults to 25

Number of records to return per page.

string
Defaults to 1

Denotes the current page number.

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

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