Skip to main content

List Webhooks

Returns a list of Webhooks 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.

    • url object
    • like string required
    • description object
    • like string required
    • enabled object
    • eq string required
    • created_by_id object
    • eq 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

    • 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
  • url object
  • like 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.

  • account_id integer

    Possible values: >= 1

  • all_events boolean

    Indicates whether or not this Webhook should be triggered by all events.

  • authorization string

    The authorization header to include in the request to the URL specified by url.

  • description string

    A description of this Webhook.

  • disabled_at date-time

    The date and time at which the Webhook was disabled.

  • disabled_reason string

    The reason this Webhook was disabled. This field is only present if disabled_at is present.

  • enabled boolean

    Indicates whether or not this Webhook is enabled. If false, the Webhook will not be triggered.

  • failed_attempts integer

    The number of times this Webhook has failed to be triggered. If this number exceeds the value of 3, the Webhook will be disabled.

  • shared_key string

    The shared key to verify that incoming messages came from Fleetio.

  • subscribed_events object

    The events that this Webhook is subscribed to. If all_events is true, this field will be ignored.

  • property name* boolean
  • url uri

    The URL to which this Webhook will send a POST request when triggered.

Loading...