Skip to main content
GET
/
v1
/
webhook-events
List webhook events
curl --request GET \
  --url https://api.quentli.com/v1/webhook-events \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "we_1234567890abcdefghij",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "webhookId": "w_1234567890abcdefghij",
    "status": "SUCCESSFUL",
    "payload": "<string>",
    "connectionId": "<string>",
    "nextCallAt": null
  }
]

Authorizations

​
Authorization
string
header
required

Organization API key using Authorization: Bearer sk_....

Query Parameters

​
filter
string

A qs-encoded webhookEventFilter object.

Example:

"status=FAILED&type[equals]=PAYMENT_COMPLETED"

​
skip
number
default:0

Pagination offset.

Required range: x >= 0
Example:

0

​
take
number
default:20

Pagination limit.

Required range: 1 <= x <= 100
Example:

20

​
orderBy
string

A qs-encoded webhookEventOrderBy object.

Example:

"createdAt=desc"

Response

Webhook events list

​
id
string
required

Unique identifier of the webhook event.

Example:

"we_1234567890abcdefghij"

​
createdAt
required

When the webhook event was created.

​
updatedAt
required

When the webhook event was last updated.

​
webhookId
string
required

Webhook that receives this event.

Example:

"w_1234567890abcdefghij"

​
type
enum<string>
required

Webhook event type.

Available options:
INVOICE_CREATED,
INVOICE_CANCELED,
INVOICE_PAID,
INVOICE_PAID_OTHER,
INVOICE_UPDATED,
PAYMENT_CREATED,
PAYMENT_COMPLETED,
PAYMENT_REFUNDED,
PAYMENT_REMINDER_SENT,
PAYMENT_ATTEMPT_FAILED,
PAYMENT_ATTEMPT_SUCCEEDED,
CUSTOMER_CREATED,
CUSTOMER_UPDATED,
CUSTOMER_ARCHIVED,
SUBSCRIPTION_CREATED,
SUBSCRIPTION_UPDATED,
SUBSCRIPTION_CANCELED,
PAYMENT_METHOD_CREATED
​
status
enum<string>
required

Current delivery status.

Available options:
PENDING,
SUCCESSFUL,
RETRYING,
FAILED
Example:

"SUCCESSFUL"

​
payload
string
required

Serialized event payload.

​
connectionId
string
required

Webhook connection identifier.

​
nextCallAt

Next scheduled retry time, if any.

Example:

null