Skip to main content

List Webhook Events

Returns a list of Webhook events belonging to your account.

Query Parameters
  • start_cursor string

    The start cursor for Keyset pagination.

  • per_page integer

    Possible values: >= 2 and <= 100

    Default value: 50

    The number of records per page to return.

  • filter object

    The fields, operations, and values to filter the records by.

    • status object
    • include string required
    • event object
      oneOf
    • like string required
    • webhook_id object
    • eq string required
    • last_sent_at object
      oneOf
    • lt string required
    • retried_at object
      oneOf
    • lt string required
    • created_at object
      oneOf
    • lt string required
    • updated_at object
      oneOf
    • lt string required
  • sort object

    The fields and direction to sort the results by.

    • id string

      Possible values: [asc, desc]

      Default value: desc

    • retried_at string

      Possible values: [asc, desc]

    • last_sent_at string

      Possible values: [asc, desc]

    • created_at string

      Possible values: [asc, desc]

    • updated_at string

      Possible values: [asc, desc]

Responses

OK

Schema

  • start_cursor string

    The current start cursor of the records returned.

  • next_cursor string

    The next cursor to retrieve the next page of records.

  • per_page integer

    The maxumum number of records returned.

  • estimated_remaining_count integer

    The number of remaining records including the returned records, up to a maximum of 500.

  • filtered_by object[]

    The filters applied to the returned record set.

    anyOf
  • status object
  • include string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • updated_at string

    Possible values: [asc, desc]

  • records object[]
  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

    The date and time at which this record was most recently updated.

  • attempts integer

    The number of times Fleetio attempted to send this event to the Webhook endpoint.

  • event string

    The event that triggered this Webhook.

  • last_error string

    The last error that occurred when attempting to trigger this Webhook.

  • last_sent_at date-time

    The date and time at which this webhook event was last sent.

  • payload string

    The payload that was sent to the Webhook endpoint.

  • response_body string

    The response body from the Webhook endpoint.

  • response_code integer

    The response code from the Webhook endpoint.

  • retried_at date-time

    The date and time at which this Webhook was last retried.

  • status string

    The status of this Webhook event.

  • webhook_id integer

    Possible values: >= 1

Loading...