# Webhooks

## Subscribe to webhook events

> Creates a new webhook subscription for the specified event types. Used by Zapier REST Hook.

```json
{"openapi":"3.0.0","info":{"title":"Dalmore Clients API","version":"1"},"servers":[{"url":"https://platform.dalmoregroup.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","in":"header","name":"X-API-KEY"}}},"paths":{"/clients/api/v1/webhooks/subscribe":{"post":{"description":"Creates a new webhook subscription for the specified event types. Used by Zapier REST Hook.","summary":"Subscribe to webhook events","tags":["webhooks"],"parameters":[],"operationId":"subscribe","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"targetUrl":{"type":"string","format":"uri"},"eventTypes":{"type":"array","items":{"type":"string"},"minItems":1},"name":{"type":"string"}},"required":["targetUrl","eventTypes"]}}}},"responses":{"201":{"description":"201","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"hook0SubscriptionId":{"type":"string","nullable":true}},"required":["id","hook0SubscriptionId"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["status","message","errors"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["status","message","errors"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["status","message","errors"]}}}}}}}}}
```

## Unsubscribe from webhook

> Deletes a webhook subscription by ID. Used by Zapier REST Hook.

```json
{"openapi":"3.0.0","info":{"title":"Dalmore Clients API","version":"1"},"servers":[{"url":"https://platform.dalmoregroup.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","in":"header","name":"X-API-KEY"}}},"paths":{"/clients/api/v1/webhooks/{id}":{"delete":{"description":"Deletes a webhook subscription by ID. Used by Zapier REST Hook.","summary":"Unsubscribe from webhook","tags":["webhooks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"unsubscribe","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"204":{"description":"204","content":{"application/json":{"schema":{}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["status","message","errors"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["status","message","errors"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["status","message","errors"]}}}}}}}}}
```

## List webhook subscriptions

> Returns a paginated list of webhook subscriptions.

```json
{"openapi":"3.0.0","info":{"title":"Dalmore Clients API","version":"1"},"servers":[{"url":"https://platform.dalmoregroup.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","in":"header","name":"X-API-KEY"}}},"paths":{"/clients/api/v1/webhooks":{"get":{"description":"Returns a paginated list of webhook subscriptions.","summary":"List webhook subscriptions","tags":["webhooks"],"parameters":[{"name":"page","in":"query","schema":{"default":1,"type":"number","nullable":true}},{"name":"limit","in":"query","schema":{"default":10,"type":"number","nullable":true}}],"operationId":"list","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"targetUrl":{"type":"string","format":"uri"},"eventTypes":{"type":"array","items":{"type":"string"}},"name":{"type":"string","nullable":true},"enabled":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","targetUrl","eventTypes","name","enabled","createdAt","updatedAt"]}},"meta":{"type":"object","properties":{"itemCount":{"type":"number"},"totalItems":{"type":"number"},"itemsPerPage":{"type":"number"},"totalPages":{"type":"number"},"currentPage":{"type":"number"}},"required":["itemCount","itemsPerPage","currentPage"]}},"required":["items","meta"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["status","message","errors"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["status","message","errors"]}}}}}}}}}
```

## Get available trigger types

> Returns a list of event types that can be subscribed to for triggers.

```json
{"openapi":"3.0.0","info":{"title":"Dalmore Clients API","version":"1"},"servers":[{"url":"https://platform.dalmoregroup.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","in":"header","name":"X-API-KEY"}}},"paths":{"/clients/api/v1/webhooks/trigger-types":{"get":{"description":"Returns a list of event types that can be subscribed to for triggers.","summary":"Get available trigger types","tags":["webhooks"],"parameters":[],"operationId":"triggerTypes","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventType":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"source":{"type":"string","enum":["api","external","both"]}},"required":["eventType","displayName","description","source"]}}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["status","message","errors"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["status","message","errors"]}}}}}}}}}
```

## Get available action types

> Returns a list of API endpoints available as Zapier actions.

```json
{"openapi":"3.0.0","info":{"title":"Dalmore Clients API","version":"1"},"servers":[{"url":"https://platform.dalmoregroup.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","in":"header","name":"X-API-KEY"}}},"paths":{"/clients/api/v1/webhooks/action-types":{"get":{"description":"Returns a list of API endpoints available as Zapier actions.","summary":"Get available action types","tags":["webhooks"],"parameters":[],"operationId":"actionTypes","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"method":{"type":"string","enum":["GET","POST","PATCH","PUT","DELETE"]},"endpoint":{"type":"string"},"noun":{"type":"string"}},"required":["key","displayName","description","method","endpoint","noun"]}}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["status","message","errors"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["status","message","errors"]}}}}}}}}}
```

## Perform list for event type

> Returns recent events for a specific event type. Used as a polling fallback by Zapier.

```json
{"openapi":"3.0.0","info":{"title":"Dalmore Clients API","version":"1"},"servers":[{"url":"https://platform.dalmoregroup.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","in":"header","name":"X-API-KEY"}}},"paths":{"/clients/api/v1/webhooks/perform/{eventType}":{"get":{"description":"Returns recent events for a specific event type. Used as a polling fallback by Zapier.","summary":"Perform list for event type","tags":["webhooks"],"parameters":[{"name":"eventType","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"default":50,"type":"number","nullable":true}}],"operationId":"performList","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["status","message","errors"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["status","message","errors"]}}}}}}}}}
```