Skip to main content
GET
List webhook events

Editor interactivo de filter

Utiliza este editor para generar un valor que puedes usar en el parámetro filter del query string. Para relaciones, grupos lógicos y más ejemplos, consulta la guía de filtros.

Authorizations

Authorization
string
header
required

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

Query Parameters

filter
object

Filter fields encoded with qs bracket notation.

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
object

Sort fields encoded with qs bracket notation.

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_COMPLETED,
PAYMENT_REFUNDED,
PAYMENT_ATTEMPT_FAILED,
PAYMENT_ATTEMPT_SUCCEEDED,
DISPUTE_CREATED,
DISPUTE_RESPONSE_CREATED,
DISPUTE_RESOLVED,
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