Webhooks
Webhooks Management API
This API allows the administration of the webhook keys used to send your product usage events to Skalin.
Any undocumented property or method may be changed or removed without notice.
Info
This page covers key management. Sending the events themselves is described in the webhook section.
# An inbound channel, not an outbound notification
The word "webhook" often means a notification you receive. Here it is the other way round: a Skalin webhook is an ingestion channel.
Creating a webhook produces the credentials your application uses to push its usage events into Skalin. Those events are then aggregated per account and per day, and feed the usage KPIs as well as the usage part of the health score.
To receive notifications from Skalin, configure alerts instead, with a WEBHOOK type.
# Key lifecycle
The status governs whether events are accepted:
| Status | Effect |
|---|---|
ACTIVE | The key accepts incoming events |
DISABLED | The key is kept but incoming events are rejected |
ERROR | Set by Skalin after repeated ingestion failures |
Moving a key to DISABLED stops a stream without losing the key or the history. ERROR is a state observed by Skalin: it cannot be set through the API.
# Deletion
Deleting a key makes the events sent with it rejected from that point on. Usage already ingested is kept: historical KPIs are not affected.
# Permissions
Reading is open to every user. Creating, updating and deleting require the ADMIN role.
Info
The webhooks list is not paginated: the whole collection is returned in a single array, ordered by creation date.