Skip to main content

Create Webhook

Creates a new Webhook

Request Body

  • all_events boolean
  • authorization string

    If the URL requires authentication, the value provided here gets passed as the HTTP 'Authorization' header

  • contact_archived boolean
  • contact_assigned boolean
  • contact_comment_added boolean
  • contact_created boolean
  • contact_deleted boolean
  • contact_merged boolean
  • contact_updated boolean
  • description string
  • enabled boolean
  • equipment_comment_added boolean
  • equipment_created boolean
  • equipment_deleted boolean
  • equipment_updated boolean
  • expense_entry_comment_added boolean
  • expense_entry_created boolean
  • expense_entry_deleted boolean
  • expense_entry_updated boolean
  • fault_created boolean
  • fault_resolved boolean
  • fuel_entry_comment_added boolean
  • fuel_entry_created boolean
  • fuel_entry_deleted boolean
  • fuel_entry_updated boolean
  • import_completed boolean
  • issue_closed boolean
  • issue_comment_added boolean
  • issue_created boolean
  • issue_deleted boolean
  • issue_resolved boolean
  • issue_updated boolean
  • location_entry_created boolean
  • location_entry_deleted boolean
  • location_entry_updated boolean
  • meter_entry_created boolean
  • meter_entry_deleted boolean
  • meter_entry_updated boolean
  • part_comment_added boolean
  • part_created boolean
  • part_deleted boolean
  • part_updated boolean
  • place_created boolean
  • place_deleted boolean
  • place_updated boolean
  • place_visited boolean
  • purchase_order_approved boolean
  • purchase_order_closed boolean
  • purchase_order_comment_added boolean
  • purchase_order_created boolean
  • purchase_order_deleted boolean
  • purchase_order_pending_approval boolean
  • purchase_order_purchased boolean
  • purchase_order_received boolean
  • purchase_order_updated boolean
  • service_entry_comment_added boolean
  • service_entry_created boolean
  • service_entry_deleted boolean
  • service_entry_updated boolean
  • submitted_inspection_form_created boolean
  • submitted_inspection_form_deleted boolean
  • url string required

    Possible values: <= 1000 characters

    *Must begin with http:// or https://

  • user_created boolean
  • user_updated boolean
  • user_archived boolean
  • vehicle_archived boolean
  • vehicle_assigned boolean
  • vehicle_assignment_created boolean
  • vehicle_assignment_deleted boolean
  • vehicle_assignment_updated boolean
  • vehicle_comment_added boolean
  • vehicle_created boolean
  • vehicle_deleted boolean
  • vehicle_group_changed boolean
  • vehicle_status_changed boolean
  • vehicle_updated boolean
  • vendor_comment_added boolean
  • vendor_created boolean
  • vendor_deleted boolean
  • vendor_updated boolean
  • work_order_comment_added boolean
  • work_order_created boolean
  • work_order_deleted boolean
  • work_order_status_changed boolean
  • work_order_updated boolean
Responses

OK

Response Headers

    Schema

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