Skip to main content

List Webhooks

Returns a list of Webhooks belonging to your account.

Responses

OK

Response Headers

  • X-PaginationLimit string

    The per page limit. Currently set to 100 but subject to change at any time.

  • X-Pagination-Current-Page string

    The current page. Defaults to 1.

  • X-Pagination-Total-Pages string

    The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

  • X-Pagination-Total-Count string

    The total number of records in the result set (across all pages).

Schema

array
  • 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...