> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/development/api-reference-app/system-or-webhooks.md).

# System | Webhooks

## GET /v1/system/webhooks

> Retrieve the webhook subscriptions registered for the tenant.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"System | Webhooks"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"WebhookSubscriptionList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSubscription"}},"total":{"type":"integer","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"WebhookSubscription":{"required":["self"],"type":"object","properties":{"url":{"type":"string","description":"The HTTPS endpoint deliveries are sent to.","nullable":true},"eventType":{"type":"string","description":"The catalog key of the subscribed event. Immutable after creation.","nullable":true},"actions":{"type":"array","items":{"type":"string"},"description":"The actions of the event this subscription receives. Empty only for subscriptions registered before\naction filters existed; those receive every action.","nullable":true},"status":{"type":"string","description":"Current state of the subscription: active, disabled or suspended.","nullable":true},"consecutiveFailures":{"type":"integer","description":"Number of consecutive terminal delivery failures. Reset on a successful delivery.","format":"int32"},"suspendedDate":{"type":"string","description":"When equipme suspended the subscription after repeated failures, if it did.","format":"date-time","nullable":true},"suspensionReason":{"type":"string","description":"Why the subscription was suspended, if it was.","nullable":true},"created":{"type":"string","description":"When the subscription was registered.","format":"date-time"},"modified":{"type":"string","description":"When the subscription was last changed.","format":"date-time","nullable":true},"id":{"type":"integer","description":"The identifier of the webhook subscription.","format":"int32"},"name":{"type":"string","description":"The name of the webhook subscription.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/webhooks":{"get":{"tags":["System | Webhooks"],"summary":"Retrieve the webhook subscriptions registered for the tenant.","responses":{"200":{"description":"OK: The list of webhook subscriptions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionList"}}}},"400":{"description":"BadRequest: See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key or expired access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## POST /v1/system/webhooks

> Register a new webhook subscription.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"System | Webhooks"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"CreateWebhookSubscriptionRequest":{"required":["actions","eventType","name","url"],"type":"object","properties":{"name":{"maxLength":100,"minLength":0,"type":"string","description":"A name identifying this subscription, for the customer's own benefit."},"url":{"maxLength":500,"minLength":0,"type":"string","description":"The endpoint deliveries are sent to. Must be HTTPS on port 443 and must resolve to a publicly\nroutable address — internal and loopback receivers are rejected."},"eventType":{"maxLength":100,"minLength":0,"type":"string","description":"The catalog key of the event to subscribe to. Immutable once the subscription exists — to change\nit, register a new subscription. Retrieve the available keys from the event-types endpoint."},"secret":{"maxLength":200,"minLength":32,"type":"string","description":"Optional pre-provisioned signing secret, for subscribers who manage secrets in their own vault.\nOmit it and equipme generates one, which is then returned once in the registration response.","nullable":true},"actions":{"minItems":1,"type":"array","items":{"type":"string"},"description":"The actions of the event to receive. At least one is required, and each entry must be one of the\nevent's actions from the event-types endpoint; duplicates are collapsed."}},"additionalProperties":false,"description":"Request payload to register a new webhook subscription for the calling tenant."},"WebhookSubscriptionCreated":{"required":["self"],"type":"object","properties":{"secret":{"type":"string","description":"The signing secret, returned once and never retrievable again. Store it alongside the receiving\nendpoint; a lost secret is rotated, not re-read.","nullable":true},"url":{"type":"string","description":"The HTTPS endpoint deliveries are sent to.","nullable":true},"eventType":{"type":"string","description":"The catalog key of the subscribed event. Immutable after creation.","nullable":true},"actions":{"type":"array","items":{"type":"string"},"description":"The actions of the event this subscription receives. Empty only for subscriptions registered before\naction filters existed; those receive every action.","nullable":true},"status":{"type":"string","description":"Current state of the subscription: active, disabled or suspended.","nullable":true},"consecutiveFailures":{"type":"integer","description":"Number of consecutive terminal delivery failures. Reset on a successful delivery.","format":"int32"},"suspendedDate":{"type":"string","description":"When equipme suspended the subscription after repeated failures, if it did.","format":"date-time","nullable":true},"suspensionReason":{"type":"string","description":"Why the subscription was suspended, if it was.","nullable":true},"created":{"type":"string","description":"When the subscription was registered.","format":"date-time"},"modified":{"type":"string","description":"When the subscription was last changed.","format":"date-time","nullable":true},"id":{"type":"integer","description":"The identifier of the webhook subscription.","format":"int32"},"name":{"type":"string","description":"The name of the webhook subscription.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Registration response. This is the only response that ever carries the plaintext secret."},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/webhooks":{"post":{"tags":["System | Webhooks"],"summary":"Register a new webhook subscription.","requestBody":{"description":"The subscription to register.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookSubscriptionRequest"}}}},"responses":{"201":{"description":"Created: The registered subscription, carrying the plaintext secret once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionCreated"}}}},"400":{"description":"BadRequest: Body validation failed, the event type is unknown, the url was rejected, or a subscription limit was reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key or expired access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## GET /v1/system/webhooks/{webhookId}

> Retrieve a single webhook subscription.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"System | Webhooks"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"WebhookSubscription":{"required":["self"],"type":"object","properties":{"url":{"type":"string","description":"The HTTPS endpoint deliveries are sent to.","nullable":true},"eventType":{"type":"string","description":"The catalog key of the subscribed event. Immutable after creation.","nullable":true},"actions":{"type":"array","items":{"type":"string"},"description":"The actions of the event this subscription receives. Empty only for subscriptions registered before\naction filters existed; those receive every action.","nullable":true},"status":{"type":"string","description":"Current state of the subscription: active, disabled or suspended.","nullable":true},"consecutiveFailures":{"type":"integer","description":"Number of consecutive terminal delivery failures. Reset on a successful delivery.","format":"int32"},"suspendedDate":{"type":"string","description":"When equipme suspended the subscription after repeated failures, if it did.","format":"date-time","nullable":true},"suspensionReason":{"type":"string","description":"Why the subscription was suspended, if it was.","nullable":true},"created":{"type":"string","description":"When the subscription was registered.","format":"date-time"},"modified":{"type":"string","description":"When the subscription was last changed.","format":"date-time","nullable":true},"id":{"type":"integer","description":"The identifier of the webhook subscription.","format":"int32"},"name":{"type":"string","description":"The name of the webhook subscription.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/webhooks/{webhookId}":{"get":{"tags":["System | Webhooks"],"summary":"Retrieve a single webhook subscription.","parameters":[{"name":"webhookId","in":"path","description":"The identifier of the webhook subscription.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK: The requested subscription, without the secret.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"400":{"description":"BadRequest: See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key or expired access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"NotFound: Requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## PUT /v1/system/webhooks/{webhookId}

> Update a webhook subscription.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"System | Webhooks"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"UpdateWebhookSubscriptionRequest":{"required":["actions","name","status","url"],"type":"object","properties":{"name":{"maxLength":100,"minLength":0,"type":"string","description":"A name identifying this subscription, for the customer's own benefit."},"url":{"maxLength":500,"minLength":0,"type":"string","description":"The endpoint deliveries are sent to. Changing it re-runs the full transport validation."},"status":{"maxLength":20,"minLength":0,"type":"string","description":"The desired state. Active and Disabled can be set freely; setting Active on a suspended\nsubscription reactivates it. Suspended cannot be set directly — only equipme suspends."},"actions":{"minItems":1,"type":"array","items":{"type":"string"},"description":"The actions of the subscribed event to receive. Replaces the stored filter. At least one is\nrequired, and each entry must be one of the event's actions from the event-types endpoint;\nduplicates are collapsed."}},"additionalProperties":false,"description":"Request payload to update an existing webhook subscription."},"WebhookSubscription":{"required":["self"],"type":"object","properties":{"url":{"type":"string","description":"The HTTPS endpoint deliveries are sent to.","nullable":true},"eventType":{"type":"string","description":"The catalog key of the subscribed event. Immutable after creation.","nullable":true},"actions":{"type":"array","items":{"type":"string"},"description":"The actions of the event this subscription receives. Empty only for subscriptions registered before\naction filters existed; those receive every action.","nullable":true},"status":{"type":"string","description":"Current state of the subscription: active, disabled or suspended.","nullable":true},"consecutiveFailures":{"type":"integer","description":"Number of consecutive terminal delivery failures. Reset on a successful delivery.","format":"int32"},"suspendedDate":{"type":"string","description":"When equipme suspended the subscription after repeated failures, if it did.","format":"date-time","nullable":true},"suspensionReason":{"type":"string","description":"Why the subscription was suspended, if it was.","nullable":true},"created":{"type":"string","description":"When the subscription was registered.","format":"date-time"},"modified":{"type":"string","description":"When the subscription was last changed.","format":"date-time","nullable":true},"id":{"type":"integer","description":"The identifier of the webhook subscription.","format":"int32"},"name":{"type":"string","description":"The name of the webhook subscription.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/webhooks/{webhookId}":{"put":{"tags":["System | Webhooks"],"summary":"Update a webhook subscription.","parameters":[{"name":"webhookId","in":"path","description":"The identifier of the webhook subscription.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"The updated subscription. The event type and the secret cannot be changed here.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookSubscriptionRequest"}}}},"responses":{"200":{"description":"OK: The updated subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"400":{"description":"BadRequest: Body validation failed or the url was rejected.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key or expired access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"NotFound: Requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Delete a webhook subscription.

> The subscription is soft-deleted so that its delivery log outlives it. Deliveries still queued\
> for it are cancelled.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"System | Webhooks"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/webhooks/{webhookId}":{"delete":{"tags":["System | Webhooks"],"summary":"Delete a webhook subscription.","description":"The subscription is soft-deleted so that its delivery log outlives it. Deliveries still queued\nfor it are cancelled.","parameters":[{"name":"webhookId","in":"path","description":"The identifier of the webhook subscription.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"NoContent: The subscription was deleted."},"400":{"description":"BadRequest: See response message for details.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key or expired access token.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"NotFound: Requested resource could not be found.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Retrieve the delivery log for a webhook subscription.

> Returns delivery metadata for failure analysis, newest first. The stored payload is not exposed here.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"System | Webhooks"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"WebhookDeliveryList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/WebhookDelivery"}},"total":{"type":"integer","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"WebhookDelivery":{"type":"object","properties":{"deliveryId":{"type":"string","description":"Stable across retries. This is the value sent in the X-Equipme-Delivery header and the\nsubscriber's idempotency key.","format":"uuid"},"eventType":{"type":"string","description":"The catalog key of the delivered event.","nullable":true},"status":{"type":"string","description":"Pending, sending, delivered, failed, abandoned or cancelled.","nullable":true},"attemptCount":{"type":"integer","description":"How many delivery attempts have been made.","format":"int32"},"lastAttempt":{"type":"string","description":"When the most recent attempt was made.","format":"date-time","nullable":true},"lastStatusCode":{"type":"integer","description":"HTTP status code returned by the most recent attempt.","format":"int32","nullable":true},"lastError":{"type":"string","description":"Error detail from the most recent failed attempt, or why a cancelled delivery was never sent.","nullable":true},"occurredAt":{"type":"string","description":"When the originating business event occurred. Use this for ordering — deliveries are unordered.","format":"date-time"},"created":{"type":"string","description":"When the delivery was queued.","format":"date-time"},"completionDate":{"type":"string","description":"When the delivery reached a terminal state.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"One delivery attempt record. The stored payload is deliberately not exposed here — it holds tenant\ndata that the caller may not be entitled to read through this route."},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/webhooks/{webhookId}/deliveries":{"get":{"tags":["System | Webhooks"],"summary":"Retrieve the delivery log for a webhook subscription.","description":"Returns delivery metadata for failure analysis, newest first. The stored payload is not exposed here.","parameters":[{"name":"webhookId","in":"path","description":"The identifier of the webhook subscription.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"How many deliveries to skip.","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"How many deliveries to return, at most 1000.","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK: One page of the delivery log.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeliveryList"}}}},"400":{"description":"BadRequest: See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key or expired access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"NotFound: Requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Issue a new signing secret for a webhook subscription.

> 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.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"System | Webhooks"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"WebhookSecretRotation":{"type":"object","properties":{"secret":{"type":"string","description":"The newly issued signing secret, returned once.","nullable":true},"previousSecretValidUntil":{"type":"string","description":"Until when the previous secret is still accepted.","format":"date-time"}},"additionalProperties":false,"description":"Result of a secret rotation. The previous secret stays valid until the returned timestamp, so the\nsubscriber can swap its configuration anywhere inside that window without dropping deliveries."},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/webhooks/{webhookId}/rotate-secret":{"post":{"tags":["System | Webhooks"],"summary":"Issue a new signing secret for a webhook subscription.","description":"The previous secret stays valid for an overlap window, during which deliveries are signed with\nboth. The subscriber can swap its stored copy anywhere inside that window without losing\ndeliveries.","parameters":[{"name":"webhookId","in":"path","description":"The identifier of the webhook subscription.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK: The new secret, returned once, and the overlap deadline.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSecretRotation"}}}},"400":{"description":"BadRequest: See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key or expired access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"NotFound: Requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Send a ping delivery to the subscription's registered url.

> 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.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"System | Webhooks"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"WebhookTestDelivery":{"type":"object","properties":{"deliveryId":{"type":"string","description":"Identifier of the test delivery, for correlating with the delivery log.","format":"uuid"},"statusCode":{"type":"integer","description":"HTTP status code the receiving endpoint returned.","format":"int32","nullable":true},"latencyMs":{"type":"integer","description":"How long the receiving endpoint took to respond, in milliseconds.","format":"int32","nullable":true},"error":{"type":"string","description":"Error detail when the test delivery did not succeed.","nullable":true},"innerError":{"type":"string","description":"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.","nullable":true}},"additionalProperties":false,"description":"Outcome of an on-demand test delivery. The test delivery is sent synchronously, so this carries the\nreceiver's actual response."},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/webhooks/{webhookId}/test":{"post":{"tags":["System | Webhooks"],"summary":"Send a ping delivery to the subscription's registered url.","description":"Intended for onboarding: it lets a subscriber verify its signature handling before real events\nflow. Requires update rather than read access, because it triggers an outbound request.","parameters":[{"name":"webhookId","in":"path","description":"The identifier of the webhook subscription.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK: The outcome of the test delivery.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookTestDelivery"}}}},"400":{"description":"BadRequest: See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key or expired access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"NotFound: Requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## GET /v1/system/webhooks/event-types

> Retrieve the event types available for subscription.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"System | Webhooks"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"WebhookEventTypeList":{"type":"object","properties":{"eventTypes":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"},"nullable":true},"description":"Event type to its actions. An empty list means the event has no action dimension.","nullable":true}},"additionalProperties":false,"description":"The subscribable event catalog: each event type mapped to the actions it can carry. Everything a client\nneeds to fill the `eventType` and `actions` fields of a registration."},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/webhooks/event-types":{"get":{"tags":["System | Webhooks"],"summary":"Retrieve the event types available for subscription.","responses":{"200":{"description":"OK: The subscribable event catalog.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEventTypeList"}}}},"400":{"description":"BadRequest: See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key or expired access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://hub.equipme.io/development/api-reference-app/system-or-webhooks.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
