Function getWebhookDeliveries

Parameters

• id: string

  The webhook's unique identifier.
• query: {
      eventType?: string;
      limit?: number;
      next?: string;
      prev?: string;
      sort?:
          | "status"
          | "+status"
          | "-status"
          | "triggeredAt"
          | "+triggeredAt"
          | "-triggeredAt";
      status?: "success"
      | "fail";
  }

  an object with query parameters

  • OptionaleventType?: string

    Filter resources by event-type

  • Optionallimit?: number

    Maximum number of deliveries to retrieve

  • Optionalnext?: string

    Cursor to the next page

  • Optionalprev?: string

    Cursor to previous next page

  • Optionalsort?:
        | "status"
        | "+status"
        | "-status"
        | "triggeredAt"
        | "+triggeredAt"
        | "-triggeredAt"

    Field to sort by, prefix with -/+ to indicate order

  • Optionalstatus?: "success" | "fail"

    Filter resources by status (success or fail)
• Optionaloptions: ApiCallOptions