For the complete documentation index, see llms.txt. This page is also available as Markdown.

System | Webhooks

Retrieve the webhook subscriptions registered for the tenant.

get
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Responses
200

OK: The list of webhook subscriptions.

application/json
totalinteger · int32Required
get/v1/system/webhooks
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"
  }
}

Register a new webhook subscription.

post
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Body

Request payload to register a new webhook subscription for the calling tenant.

namestring · max: 100Required

A name identifying this subscription, for the customer's own benefit.

Example: Fulfillment bridge
urlstring · max: 500Required

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

Example: https://example.com/hooks/equipme
eventTypestring · max: 100Required

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

Example: ping
secretstring · min: 32 · max: 200 · nullableOptional

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

Example: d1Xk2vP9mN4tR8wL1cJ5hB3dF6gY0aS7
actionsstring[] · min: 1Required

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

Example: ["Creation","Deletion"]
Responses
201

Created: The registered subscription, carrying the plaintext secret once.

application/json

Registration response. This is the only response that ever carries the plaintext secret.

secretstring · nullableOptional

The signing secret, returned once and never retrievable again. Store it alongside the receiving endpoint; a lost secret is rotated, not re-read.

Example: d1Xk2vP9mN4tR8wL1cJ5hB3dF6gY0aS7
urlstring · nullableOptional

The HTTPS endpoint deliveries are sent to.

Example: https://example.com/hooks/equipme
eventTypestring · nullableOptional

The catalog key of the subscribed event. Immutable after creation.

Example: ping
actionsstring[] · nullableOptional

The actions of the event this subscription receives. Empty only for subscriptions registered before action filters existed; those receive every action.

Example: ["Creation","Deletion"]
statusstring · nullableOptional

Current state of the subscription: active, disabled or suspended.

Example: active
consecutiveFailuresinteger · int32Optional

Number of consecutive terminal delivery failures. Reset on a successful delivery.

Example: 0
suspendedDatestring · date-time · nullableOptional

When equipme suspended the subscription after repeated failures, if it did.

suspensionReasonstring · nullableOptional

Why the subscription was suspended, if it was.

Example: 10 consecutive delivery failures
createdstring · date-timeOptional

When the subscription was registered.

modifiedstring · date-time · nullableOptional

When the subscription was last changed.

idinteger · int32Optional

The identifier of the webhook subscription.

Example: 42
namestring · nullableOptional

The name of the webhook subscription.

Example: Fulfillment bridge
post/v1/system/webhooks
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"
  }
}

Retrieve a single webhook subscription.

get
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
webhookIdinteger · int32Required

The identifier of the webhook subscription.

Responses
200

OK: The requested subscription, without the secret.

application/json
urlstring · nullableOptional

The HTTPS endpoint deliveries are sent to.

Example: https://example.com/hooks/equipme
eventTypestring · nullableOptional

The catalog key of the subscribed event. Immutable after creation.

Example: ping
actionsstring[] · nullableOptional

The actions of the event this subscription receives. Empty only for subscriptions registered before action filters existed; those receive every action.

Example: ["Creation","Deletion"]
statusstring · nullableOptional

Current state of the subscription: active, disabled or suspended.

Example: active
consecutiveFailuresinteger · int32Optional

Number of consecutive terminal delivery failures. Reset on a successful delivery.

Example: 0
suspendedDatestring · date-time · nullableOptional

When equipme suspended the subscription after repeated failures, if it did.

suspensionReasonstring · nullableOptional

Why the subscription was suspended, if it was.

Example: 10 consecutive delivery failures
createdstring · date-timeOptional

When the subscription was registered.

modifiedstring · date-time · nullableOptional

When the subscription was last changed.

idinteger · int32Optional

The identifier of the webhook subscription.

Example: 42
namestring · nullableOptional

The name of the webhook subscription.

Example: Fulfillment bridge
get/v1/system/webhooks/{webhookId}
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"
  }
}

Update a webhook subscription.

put
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
webhookIdinteger · int32Required

The identifier of the webhook subscription.

Body

Request payload to update an existing webhook subscription.

namestring · max: 100Required

A name identifying this subscription, for the customer's own benefit.

Example: Fulfillment bridge
urlstring · max: 500Required

The endpoint deliveries are sent to. Changing it re-runs the full transport validation.

Example: https://example.com/hooks/equipme
statusstring · max: 20Required

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

Example: Active
actionsstring[] · min: 1Required

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

Example: ["Creation","Deletion"]
Responses
200

OK: The updated subscription.

application/json
urlstring · nullableOptional

The HTTPS endpoint deliveries are sent to.

Example: https://example.com/hooks/equipme
eventTypestring · nullableOptional

The catalog key of the subscribed event. Immutable after creation.

Example: ping
actionsstring[] · nullableOptional

The actions of the event this subscription receives. Empty only for subscriptions registered before action filters existed; those receive every action.

Example: ["Creation","Deletion"]
statusstring · nullableOptional

Current state of the subscription: active, disabled or suspended.

Example: active
consecutiveFailuresinteger · int32Optional

Number of consecutive terminal delivery failures. Reset on a successful delivery.

Example: 0
suspendedDatestring · date-time · nullableOptional

When equipme suspended the subscription after repeated failures, if it did.

suspensionReasonstring · nullableOptional

Why the subscription was suspended, if it was.

Example: 10 consecutive delivery failures
createdstring · date-timeOptional

When the subscription was registered.

modifiedstring · date-time · nullableOptional

When the subscription was last changed.

idinteger · int32Optional

The identifier of the webhook subscription.

Example: 42
namestring · nullableOptional

The name of the webhook subscription.

Example: Fulfillment bridge
put/v1/system/webhooks/{webhookId}
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"
  }
}

Delete a webhook subscription.

delete

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

Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
webhookIdinteger · int32Required

The identifier of the webhook subscription.

Responses
204

NoContent: The subscription was deleted.

No content

delete/v1/system/webhooks/{webhookId}
DELETE /v1/system/webhooks/{webhookId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Retrieve the delivery log for a webhook subscription.

get

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

Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
webhookIdinteger · int32Required

The identifier of the webhook subscription.

Query parameters
offsetinteger · int32Optional

How many deliveries to skip.

Default: 0
limitinteger · int32Optional

How many deliveries to return, at most 1000.

Default: 100
Responses
200

OK: One page of the delivery log.

application/json
totalinteger · int32Required
get/v1/system/webhooks/{webhookId}/deliveries
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"
  }
}

Issue a new signing secret for a webhook subscription.

post

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.

Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
webhookIdinteger · int32Required

The identifier of the webhook subscription.

Responses
200

OK: The new secret, returned once, and the overlap deadline.

application/json

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.

secretstring · nullableOptional

The newly issued signing secret, returned once.

Example: Hj4mQ8xV2nK6pT0yW5rC9bZ1fD7sG3uA
previousSecretValidUntilstring · date-timeOptional

Until when the previous secret is still accepted.

post/v1/system/webhooks/{webhookId}/rotate-secret
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"
}

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

post

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.

Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
webhookIdinteger · int32Required

The identifier of the webhook subscription.

Responses
200

OK: The outcome of the test delivery.

application/json

Outcome of an on-demand test delivery. The test delivery is sent synchronously, so this carries the receiver's actual response.

deliveryIdstring · uuidOptional

Identifier of the test delivery, for correlating with the delivery log.

statusCodeinteger · int32 · nullableOptional

HTTP status code the receiving endpoint returned.

Example: 200
latencyMsinteger · int32 · nullableOptional

How long the receiving endpoint took to respond, in milliseconds.

Example: 143
errorstring · nullableOptional

Error detail when the test delivery did not succeed.

innerErrorstring · nullableOptional

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.

post/v1/system/webhooks/{webhookId}/test
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"
}

Retrieve the event types available for subscription.

get
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Responses
200

OK: The subscribable event catalog.

application/json

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.

get/v1/system/webhooks/event-types
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?