{"openapi":"3.1.0","info":{"title":"GET /api/v1/webhooks/o2c/event-types","version":"1.0.0","description":"List subscribable webhook event types"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/webhooks/o2c/event-types":{"get":{"tags":["o2c-webhooks"],"summary":"List subscribable webhook event types","description":"Every event an endpoint can subscribe to, with its group, a description, whether it is delivered in the standard envelope, and a sample `data` body. The same list validates `event_types` on create and update.","operationId":"list_webhook_event_types","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_WebhookEventTypesResponse_"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"list_webhook_event_types_api_v1_webhooks_o2c_event_types_get"}}},"components":{"schemas":{"SuccessEnvelope_WebhookEventTypesResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/WebhookEventTypesResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[WebhookEventTypesResponse]"},"WebhookEventTypeResponse":{"properties":{"type":{"type":"string","title":"Type","description":"Event type name, e.g. `invoice.paid`."},"group":{"type":"string","title":"Group","description":"books, o2c, close or credit."},"category":{"type":"string","title":"Category","description":"Display category the event is listed under."},"description":{"type":"string","title":"Description","description":"What triggers this event."},"envelope":{"type":"boolean","title":"Envelope","description":"True when delivered as {id, type, created_at, business_id, data, api_version}; false for older events with their own payload shape."},"sample":{"additionalProperties":true,"type":"object","title":"Sample","description":"Example `data` (envelope events)."}},"type":"object","required":["type","group","category","description","envelope"],"title":"WebhookEventTypeResponse","description":"One subscribable event type, from the registry."},"WebhookEventTypesResponse":{"properties":{"api_version":{"type":"string","title":"Api Version","description":"Envelope API version stamped on deliveries."},"event_types":{"items":{"$ref":"#/components/schemas/WebhookEventTypeResponse"},"type":"array","title":"Event Types","description":"Every event type an endpoint can subscribe to."}},"type":"object","required":["api_version","event_types"],"title":"WebhookEventTypesResponse","description":"Catalog of events an endpoint can subscribe to."},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}