Retrieve Webhook Event

Retrieve the details of an existing Webhook Event.

Path Parameters

• id string required

  Possible values: Value must match regular expression ^[0-9]+$

  The id of the relevant record

Responses

• 200
• 401
• 403
• 404
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

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.

• 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

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "attempts": 0,
  "event": "string",
  "last_error": "string",
  "last_sent_at": "2023-03-14T13:46:27-06:00",
  "payload": "string",
  "response_body": "string",
  "response_code": 0,
  "retried_at": "2023-03-14T13:46:27-06:00",
  "status": "string",
  "webhook_id": 0
}

Request could not be authenticated

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

• detail string

  A human-readable explanation specific to this occurrence of the problem.

• instance string

  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Insufficient permission to perform this operation

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

• detail string

  A human-readable explanation specific to this occurrence of the problem.

• instance string

  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

The requested resource could not be located

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

• detail string

  A human-readable explanation specific to this occurrence of the problem.

• instance string

  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Something unexpected happened

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

• detail string

  A human-readable explanation specific to this occurrence of the problem.

• instance string

  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Loading...