Webhooks
Get webhook endpoints
- Documentation
- API Reference
- Integrations
- Changelog
- Blog
- GETGet analytics
- GETGet companies
- GETGet custom properties
- POSTCreate custom property
- PUTUpdate custom property
- DELDelete custom property
- GETGet customers
- POSTCreate customer
- GETGet customer
- PUTUpdate customer
- DELDelete customer
- GETGet customer portal
- PUTArchive customer
- POSTBulk update providers/customers mapping
- GETList credit products
- POSTCreate credit product
- GETGet credit product
- GETList credit transactions
- POSTPurchase credits
- POSTTopup credits
- POSTCreate credits usage
- POSTCreate component token
- GETGet invoices
- POSTCreate one-off invoice
- POSTSends a draft invoice for payment
- GETGet invoice
- GETDownload invoice
- POSTCreate transaction
- GETGet invoicing entities
- POSTCreate invoicing entity
- GETGet invoicing entity
- PUTUpdate invoicing entity
- DELDelete invoicing entity
- POSTCreate payment
- POSTUpdate prices
- POSTRefresh subscriptions
- POSTCreate subscription update
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- GETGet subscriptions
- POSTCreate subscription
- GETGet subscription
- POSTRefresh seat products
Analytics
Companies
Custom properties
Customers
Customers > Credits
Integrations
Invoices
Invoicing entities
Payments
Price configurations
Subscriptions
Webhooks
Get webhook endpoints
Retrieve all webhook endpoints.
GET
/
v1
/
webhooks
/
endpoints
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
limit
number
limit
number
iterator
string
iterator
string
curl --request GET \
--url https://api.hyperline.co/v1/webhooks/endpoints \
--header 'Authorization: Bearer <token>'{
"meta": {
"iterator": "<string>"
},
"data": [
{
"id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
"description": "Production webhook endpoint",
"url": "https://example.com/webhook",
"rate_limit": 123,
"event_types": [
"customer.created",
"customer.updated"
],
"created_at": "2023-01-20T16:04:11Z"
}
]
}Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
limit
number
iterator
string
Response
200 - application/json
meta
object
requiredmeta.iterator
string | null
requireddata
object[]
requireddata.id
string
requiredWebhook endpoint ID.
data.description
string
requiredWebhook endpoint description.
data.url
string
requiredWebhook endpoint URL.
data.rate_limit
number | null
requiredWebhook rate limit (per second).
data.event_types
enum<string>[] | null
requiredWebhook event types filter. If not defined, all event messages will be sent.
Available options:
customer.created, customer.updated, customer.archived, customer.recovered, customer.deleted, subscription.created, subscription.trial_ended, subscription.activated, subscription.paused, subscription.updated, subscription.cancellation_scheduled, subscription.cancelled, subscription.voided, subscription.errored, subscription.charged, subscription.commitment_renewed, invoice.grace_period.started, invoice.ready, invoice.settled, credit_note.ready, credit_note.settled, checkout.created, checkout.completed, payment_method.created, payment_method.activated, payment_method.errored, payment_method.deleted, wallet.credited, wallet.debited, daily_analytics.ready, dataloader.failed, credit.low_balance, credit.balance_refreshed, credit.created, credit.updated, credit.balance_at_zero, credit.topup_transaction_created, credit.usage_transaction_created, quote.created, quote.updated, quote.approved, quote.sent, quote.signed, quote.voided data.created_at
string
requiredWebhook creation date.
curl --request GET \
--url https://api.hyperline.co/v1/webhooks/endpoints \
--header 'Authorization: Bearer <token>'{
"meta": {
"iterator": "<string>"
},
"data": [
{
"id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
"description": "Production webhook endpoint",
"url": "https://example.com/webhook",
"rate_limit": 123,
"event_types": [
"customer.created",
"customer.updated"
],
"created_at": "2023-01-20T16:04:11Z"
}
]
}