System | Webhooks
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
OK: The list of webhook subscriptions.
BadRequest: See response message for details.
Unauthorized: Invalid api key or expired access token.
Forbidden: Resource access denied.
GET /v1/system/webhooks HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"previous": {
"href": "text",
"method": "text"
},
"next": {
"href": "text",
"method": "text"
},
"items": [
{
"url": "https://example.com/hooks/equipme",
"eventType": "ping",
"actions": [
"Creation",
"Deletion"
],
"status": "active",
"consecutiveFailures": 0,
"suspendedDate": "2026-01-01T00:00:00.000Z",
"suspensionReason": "10 consecutive delivery failures",
"created": "2026-01-01T00:00:00.000Z",
"modified": "2026-01-01T00:00:00.000Z",
"id": 42,
"name": "Fulfillment bridge",
"self": {
"href": "text",
"method": "text"
}
}
],
"total": 1,
"self": {
"href": "text",
"method": "text"
}
}Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
Request payload to register a new webhook subscription for the calling tenant.
A name identifying this subscription, for the customer's own benefit.
Fulfillment bridgeThe endpoint deliveries are sent to. Must be HTTPS on port 443 and must resolve to a publicly routable address — internal and loopback receivers are rejected.
https://example.com/hooks/equipmeThe catalog key of the event to subscribe to. Immutable once the subscription exists — to change it, register a new subscription. Retrieve the available keys from the event-types endpoint.
pingOptional pre-provisioned signing secret, for subscribers who manage secrets in their own vault. Omit it and equipme generates one, which is then returned once in the registration response.
d1Xk2vP9mN4tR8wL1cJ5hB3dF6gY0aS7The actions of the event to receive. At least one is required, and each entry must be one of the event's actions from the event-types endpoint; duplicates are collapsed.
["Creation","Deletion"]Created: The registered subscription, carrying the plaintext secret once.
Registration response. This is the only response that ever carries the plaintext secret.
The signing secret, returned once and never retrievable again. Store it alongside the receiving endpoint; a lost secret is rotated, not re-read.
d1Xk2vP9mN4tR8wL1cJ5hB3dF6gY0aS7The HTTPS endpoint deliveries are sent to.
https://example.com/hooks/equipmeThe catalog key of the subscribed event. Immutable after creation.
pingThe actions of the event this subscription receives. Empty only for subscriptions registered before action filters existed; those receive every action.
["Creation","Deletion"]Current state of the subscription: active, disabled or suspended.
activeNumber of consecutive terminal delivery failures. Reset on a successful delivery.
0When equipme suspended the subscription after repeated failures, if it did.
Why the subscription was suspended, if it was.
10 consecutive delivery failuresWhen the subscription was registered.
When the subscription was last changed.
The identifier of the webhook subscription.
42The name of the webhook subscription.
Fulfillment bridgeBadRequest: Body validation failed, the event type is unknown, the url was rejected, or a subscription limit was reached.
Unauthorized: Invalid api key or expired access token.
Forbidden: Resource access denied.
POST /v1/system/webhooks HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 168
{
"name": "Fulfillment bridge",
"url": "https://example.com/hooks/equipme",
"eventType": "ping",
"secret": "d1Xk2vP9mN4tR8wL1cJ5hB3dF6gY0aS7",
"actions": [
"Creation",
"Deletion"
]
}{
"secret": "d1Xk2vP9mN4tR8wL1cJ5hB3dF6gY0aS7",
"url": "https://example.com/hooks/equipme",
"eventType": "ping",
"actions": [
"Creation",
"Deletion"
],
"status": "active",
"consecutiveFailures": 0,
"suspendedDate": "2026-01-01T00:00:00.000Z",
"suspensionReason": "10 consecutive delivery failures",
"created": "2026-01-01T00:00:00.000Z",
"modified": "2026-01-01T00:00:00.000Z",
"id": 42,
"name": "Fulfillment bridge",
"self": {
"href": "text",
"method": "text"
}
}Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the webhook subscription.
OK: The requested subscription, without the secret.
The HTTPS endpoint deliveries are sent to.
https://example.com/hooks/equipmeThe catalog key of the subscribed event. Immutable after creation.
pingThe actions of the event this subscription receives. Empty only for subscriptions registered before action filters existed; those receive every action.
["Creation","Deletion"]Current state of the subscription: active, disabled or suspended.
activeNumber of consecutive terminal delivery failures. Reset on a successful delivery.
0When equipme suspended the subscription after repeated failures, if it did.
Why the subscription was suspended, if it was.
10 consecutive delivery failuresWhen the subscription was registered.
When the subscription was last changed.
The identifier of the webhook subscription.
42The name of the webhook subscription.
Fulfillment bridgeBadRequest: See response message for details.
Unauthorized: Invalid api key or expired access token.
Forbidden: Resource access denied.
NotFound: Requested resource could not be found.
GET /v1/system/webhooks/{webhookId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"url": "https://example.com/hooks/equipme",
"eventType": "ping",
"actions": [
"Creation",
"Deletion"
],
"status": "active",
"consecutiveFailures": 0,
"suspendedDate": "2026-01-01T00:00:00.000Z",
"suspensionReason": "10 consecutive delivery failures",
"created": "2026-01-01T00:00:00.000Z",
"modified": "2026-01-01T00:00:00.000Z",
"id": 42,
"name": "Fulfillment bridge",
"self": {
"href": "text",
"method": "text"
}
}Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the webhook subscription.
Request payload to update an existing webhook subscription.
A name identifying this subscription, for the customer's own benefit.
Fulfillment bridgeThe endpoint deliveries are sent to. Changing it re-runs the full transport validation.
https://example.com/hooks/equipmeThe desired state. Active and Disabled can be set freely; setting Active on a suspended subscription reactivates it. Suspended cannot be set directly — only equipme suspends.
ActiveThe actions of the subscribed event to receive. Replaces the stored filter. At least one is required, and each entry must be one of the event's actions from the event-types endpoint; duplicates are collapsed.
["Creation","Deletion"]OK: The updated subscription.
The HTTPS endpoint deliveries are sent to.
https://example.com/hooks/equipmeThe catalog key of the subscribed event. Immutable after creation.
pingThe actions of the event this subscription receives. Empty only for subscriptions registered before action filters existed; those receive every action.
["Creation","Deletion"]Current state of the subscription: active, disabled or suspended.
activeNumber of consecutive terminal delivery failures. Reset on a successful delivery.
0When equipme suspended the subscription after repeated failures, if it did.
Why the subscription was suspended, if it was.
10 consecutive delivery failuresWhen the subscription was registered.
When the subscription was last changed.
The identifier of the webhook subscription.
42The name of the webhook subscription.
Fulfillment bridgeBadRequest: Body validation failed or the url was rejected.
Unauthorized: Invalid api key or expired access token.
Forbidden: Resource access denied.
NotFound: Requested resource could not be found.
PUT /v1/system/webhooks/{webhookId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 123
{
"name": "Fulfillment bridge",
"url": "https://example.com/hooks/equipme",
"status": "Active",
"actions": [
"Creation",
"Deletion"
]
}{
"url": "https://example.com/hooks/equipme",
"eventType": "ping",
"actions": [
"Creation",
"Deletion"
],
"status": "active",
"consecutiveFailures": 0,
"suspendedDate": "2026-01-01T00:00:00.000Z",
"suspensionReason": "10 consecutive delivery failures",
"created": "2026-01-01T00:00:00.000Z",
"modified": "2026-01-01T00:00:00.000Z",
"id": 42,
"name": "Fulfillment bridge",
"self": {
"href": "text",
"method": "text"
}
}The subscription is soft-deleted so that its delivery log outlives it. Deliveries still queued for it are cancelled.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the webhook subscription.
NoContent: The subscription was deleted.
No content
BadRequest: See response message for details.
Unauthorized: Invalid api key or expired access token.
Forbidden: Resource access denied.
NotFound: Requested resource could not be found.
DELETE /v1/system/webhooks/{webhookId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
No content
Returns delivery metadata for failure analysis, newest first. The stored payload is not exposed here.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the webhook subscription.
How many deliveries to skip.
0How many deliveries to return, at most 1000.
100OK: One page of the delivery log.
BadRequest: See response message for details.
Unauthorized: Invalid api key or expired access token.
Forbidden: Resource access denied.
NotFound: Requested resource could not be found.
GET /v1/system/webhooks/{webhookId}/deliveries HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"previous": {
"href": "text",
"method": "text"
},
"next": {
"href": "text",
"method": "text"
},
"items": [
{
"deliveryId": "123e4567-e89b-12d3-a456-426614174000",
"eventType": "ping",
"status": "delivered",
"attemptCount": 1,
"lastAttempt": "2026-01-01T00:00:00.000Z",
"lastStatusCode": 200,
"lastError": "text",
"occurredAt": "2026-01-01T00:00:00.000Z",
"created": "2026-01-01T00:00:00.000Z",
"completionDate": "2026-01-01T00:00:00.000Z"
}
],
"total": 1,
"self": {
"href": "text",
"method": "text"
}
}The previous secret stays valid for an overlap window, during which deliveries are signed with both. The subscriber can swap its stored copy anywhere inside that window without losing deliveries.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the webhook subscription.
OK: The new secret, returned once, and the overlap deadline.
Result of a secret rotation. The previous secret stays valid until the returned timestamp, so the subscriber can swap its configuration anywhere inside that window without dropping deliveries.
The newly issued signing secret, returned once.
Hj4mQ8xV2nK6pT0yW5rC9bZ1fD7sG3uAUntil when the previous secret is still accepted.
BadRequest: See response message for details.
Unauthorized: Invalid api key or expired access token.
Forbidden: Resource access denied.
NotFound: Requested resource could not be found.
POST /v1/system/webhooks/{webhookId}/rotate-secret HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"secret": "Hj4mQ8xV2nK6pT0yW5rC9bZ1fD7sG3uA",
"previousSecretValidUntil": "2026-01-01T00:00:00.000Z"
}Intended for onboarding: it lets a subscriber verify its signature handling before real events flow. Requires update rather than read access, because it triggers an outbound request.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the webhook subscription.
OK: The outcome of the test delivery.
Outcome of an on-demand test delivery. The test delivery is sent synchronously, so this carries the receiver's actual response.
Identifier of the test delivery, for correlating with the delivery log.
HTTP status code the receiving endpoint returned.
200How long the receiving endpoint took to respond, in milliseconds.
143Error detail when the test delivery did not succeed.
Inner error detail when the test delivery did not succeed. This is the raw exception message from the HTTP client, which may be more specific than the equipme.api.Dto.System.WebhookTestDelivery.Error property.
BadRequest: See response message for details.
Unauthorized: Invalid api key or expired access token.
Forbidden: Resource access denied.
NotFound: Requested resource could not be found.
POST /v1/system/webhooks/{webhookId}/test HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"deliveryId": "123e4567-e89b-12d3-a456-426614174000",
"statusCode": 200,
"latencyMs": 143,
"error": "text",
"innerError": "text"
}Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
OK: The subscribable event catalog.
The subscribable event catalog: each event type mapped to the actions it can carry. Everything a client
needs to fill the eventType and actions fields of a registration.
BadRequest: See response message for details.
Unauthorized: Invalid api key or expired access token.
Forbidden: Resource access denied.
GET /v1/system/webhooks/event-types HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"eventTypes": {
"ping": [],
"employee": [
"creation",
"deletion",
"propertyChange",
"associationChange"
]
}
}Last updated
Was this helpful?