Webhooks
Authorization
bearerAuth In: header
Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/tables-api/v1/webhook-subscriptions" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "data": [ { "id": "string", "object": "reservation", "action": "create", "url": "http://example.com", "enabled": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ]}Authorization
bearerAuth In: header
Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
8 <= length <= 180Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/tables-api/v1/webhook-subscriptions" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "idempotency-key: stringst" \ -H "Content-Type: application/json" \ -d '{ "object": "reservation", "action": "create", "url": "http://example.com" }'{ "data": { "id": "string", "object": "reservation", "action": "create", "url": "http://example.com", "enabled": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "signingSecret": "string" }}Authorization
bearerAuth In: header
Path Parameters
1 <= length <= 200Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
8 <= length <= 180Response Body
curl -X DELETE "https://example.com/tables-api/v1/webhook-subscriptions/string" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "idempotency-key: stringst"Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/web-hook-dead-letters" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "deadLetters": [ { "id": "string", "objectType": "string", "action": "string", "aggregateId": "string", "payloadKeys": [ "string" ], "status": "pending", "attemptCount": 0, "deliveryCycle": 0, "availableAt": "2019-08-24T14:15:22Z", "lastError": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "attemptSummary": { "total": 0, "failed": 0, "succeeded": 0, "delivering": 0 }, "subscriptionSummary": { "matching": 0, "enabled": 0 }, "recovery": { "eligible": true, "reasonCode": "string", "reason": "string", "latestAction": { "id": "string", "action": "manual_review", "deliveryCycle": 0, "note": "string", "actorStaffUserId": "string", "createdAt": "2019-08-24T14:15:22Z" } } } ], "total": 0}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/web-hook-dead-letters/string" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "id": "string", "objectType": "string", "action": "string", "aggregateId": "string", "payloadKeys": [ "string" ], "status": "pending", "attemptCount": 0, "deliveryCycle": 0, "availableAt": "2019-08-24T14:15:22Z", "lastError": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "attemptSummary": { "total": 0, "failed": 0, "succeeded": 0, "delivering": 0 }, "subscriptionSummary": { "matching": 0, "enabled": 0 }, "recovery": { "eligible": true, "reasonCode": "string", "reason": "string", "latestAction": { "id": "string", "action": "manual_review", "deliveryCycle": 0, "note": "string", "actorStaffUserId": "string", "createdAt": "2019-08-24T14:15:22Z" } }, "attempts": [ { "id": "string", "subscriptionId": "string", "attemptNumber": 0, "deliveryCycle": 0, "status": "delivering", "requestHeaders": { "property1": "string", "property2": "string" }, "responseStatus": 0, "hasResponseBody": true, "responseBodyBytes": 0, "errorMessage": "string", "startedAt": "2019-08-24T14:15:22Z", "completedAt": "2019-08-24T14:15:22Z" } ]}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/web-hook-dead-letters/string/manual-review" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "note": "string" }'{ "id": "string", "objectType": "string", "action": "string", "aggregateId": "string", "payloadKeys": [ "string" ], "status": "pending", "attemptCount": 0, "deliveryCycle": 0, "availableAt": "2019-08-24T14:15:22Z", "lastError": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "attemptSummary": { "total": 0, "failed": 0, "succeeded": 0, "delivering": 0 }, "subscriptionSummary": { "matching": 0, "enabled": 0 }, "recovery": { "eligible": true, "reasonCode": "string", "reason": "string", "latestAction": { "id": "string", "action": "manual_review", "deliveryCycle": 0, "note": "string", "actorStaffUserId": "string", "createdAt": "2019-08-24T14:15:22Z" } }, "attempts": [ { "id": "string", "subscriptionId": "string", "attemptNumber": 0, "deliveryCycle": 0, "status": "delivering", "requestHeaders": { "property1": "string", "property2": "string" }, "responseStatus": 0, "hasResponseBody": true, "responseBodyBytes": 0, "errorMessage": "string", "startedAt": "2019-08-24T14:15:22Z", "completedAt": "2019-08-24T14:15:22Z" } ]}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X POST "https://example.com/web-hook-dead-letters/string/replay" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "id": "string", "objectType": "string", "action": "string", "aggregateId": "string", "payloadKeys": [ "string" ], "status": "pending", "attemptCount": 0, "deliveryCycle": 0, "availableAt": "2019-08-24T14:15:22Z", "lastError": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "attemptSummary": { "total": 0, "failed": 0, "succeeded": 0, "delivering": 0 }, "subscriptionSummary": { "matching": 0, "enabled": 0 }, "recovery": { "eligible": true, "reasonCode": "string", "reason": "string", "latestAction": { "id": "string", "action": "manual_review", "deliveryCycle": 0, "note": "string", "actorStaffUserId": "string", "createdAt": "2019-08-24T14:15:22Z" } }}Commerce7 basis: Webhooks. This contract-first slice models webhook subscriptions with search and basic lifecycle management.
Query Parameters
1 <= value1 <= value <= 100Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/web-hook" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "webhooks": [ { "id": "string", "object": "customer", "action": "create", "url": "http://example.com", "enabled": true, "headers": { "property1": "string", "property2": "string" }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "page": { "total": 0, "page": 1, "limit": 1 }}Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/web-hook" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "object": "customer", "action": "create", "url": "http://example.com" }'{ "id": "string", "object": "customer", "action": "create", "url": "http://example.com", "enabled": true, "headers": { "property1": "string", "property2": "string" }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "secret": "string"}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/web-hook/string" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "id": "string", "object": "customer", "action": "create", "url": "http://example.com", "enabled": true, "headers": { "property1": "string", "property2": "string" }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
curl -X DELETE "https://example.com/web-hook/string" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PUT "https://example.com/web-hook/string" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "object": "customer", "action": "create", "url": "http://example.com", "enabled": true, "headers": { "property1": "string", "property2": "string" }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}Query Parameters
1 <= value <= 200Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/web-hook-events" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "events": [ { "id": "string", "tenantId": "string", "objectType": "string", "action": "string", "aggregateId": "string", "payload": { "property1": null, "property2": null }, "idempotencyKey": "string", "status": "pending", "attemptCount": 0, "deliveryCycle": 0, "availableAt": "2019-08-24T14:15:22Z", "deliveredAt": "2019-08-24T14:15:22Z", "lastError": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "total": 0}Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/web-hook-events" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "objectType": "string", "action": "string", "payload": { "property1": null, "property2": null }, "idempotencyKey": "stringst" }'{ "id": "string", "tenantId": "string", "objectType": "string", "action": "string", "aggregateId": "string", "payload": { "property1": null, "property2": null }, "idempotencyKey": "string", "status": "pending", "attemptCount": 0, "deliveryCycle": 0, "availableAt": "2019-08-24T14:15:22Z", "deliveredAt": "2019-08-24T14:15:22Z", "lastError": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X POST "https://example.com/web-hook-events/string/replay" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "id": "string", "tenantId": "string", "objectType": "string", "action": "string", "aggregateId": "string", "payload": { "property1": null, "property2": null }, "idempotencyKey": "string", "status": "pending", "attemptCount": 0, "deliveryCycle": 0, "availableAt": "2019-08-24T14:15:22Z", "deliveredAt": "2019-08-24T14:15:22Z", "lastError": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/web-hook-events/process" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{}'{ "results": [ { "eventId": "string", "status": "pending", "deliveries": 0 } ]}