Skip to main content

Search webhook notification logs

GET 
/api/v2/public/webhooks/logs

Webhook logs are stored for 14 days and are used for debugging purposes.

Searching webhook logs can help you troubleshoot issues by providing detailed information about the webhook events and their payloads. This can be crucial for diagnosing problems, verifying event delivery, and ensuring your integration is functioning correctly.

Request​

Query Parameters

    facilitiesIds string[]

    The facilities IDs to filter the logs.

    eventType string

    Possible values: [shift.request.created, shift.request.cancelled, shift.report.created, shift.scheduled.cancelled, shift.scheduled, shift.created, shift.report.accepted-automatically, shift.report.accepted, shift.report.rejected, shift.cancelled, all]

    The event type to filter the logs.

    startDate date-time

    Filters logs that happened after this date

    Example: 2022-10-10T10:00:00.000Z
    endDate date-time

    Filters logs that happened before this date

    Example: 2022-10-11T10:00:00.000Z
    limit number

    Possible values: <= 100

    Default value: 10

    Pagination parameter, use to specify the quantity of records returned

    Example: 10
    offset number

    Default value: 0

    Pagination parameter, use to specify the number of records to skip before starting to return results

    Example: 10
    sortDirection string

    Possible values: [ASC, DESC]

    Default value: DESC

    Pagination parameter, use to specify the order of records by creation date, either 'asc' for ascending or 'desc' for descending

    Example: DESC

Responses​

Schema
    data object[]
  • Array [
    • id stringrequired

    The webhook log ID.

    facilityId stringrequired

    Id of the Facility

    eventType stringrequired

    Possible values: [shift.request.created, shift.request.cancelled, shift.report.created, shift.scheduled.cancelled, shift.scheduled, shift.created, shift.report.accepted-automatically, shift.report.accepted, shift.report.rejected, shift.cancelled, all]

    The event type.

    requestPayload objectrequired

    The request payload.

    responseStatus numberrequired

    The received response status code when the event was sent.

    responseBody stringrequired

    The received response body when the event was sent.

    url stringrequired

    The url used to dispatch the webhook.

    retries objectrequired
    id stringrequired

    The webhook log ID.

    facilityId stringrequired

    Id of the Facility

    eventType stringrequired

    Possible values: [shift.request.created, shift.request.cancelled, shift.report.created, shift.scheduled.cancelled, shift.scheduled, shift.created, shift.report.accepted-automatically, shift.report.accepted, shift.report.rejected, shift.cancelled, all]

    The event type.

    requestPayload objectrequired

    The request payload.

    responseStatus numberrequired

    The received response status code when the event was sent.

    responseBody stringrequired

    The received response body when the event was sent.

    url stringrequired

    The url used to dispatch the webhook.

    retryAttempt numberrequired

    The number indicating the attempt to resend the webhook

    status stringrequired

    Possible values: [success, failure]

    The status of the webhook, if at least a single retry succeeds the status will be success.

  • ]
Loading...