CodeCow/chatwoot
1
0
Fork 0
mirror of https://github.com/chatwoot/chatwoot.git synced 2026-06-04 21:02:35 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
develop
chatwoot/swagger/definitions/resource
History
Syed Muhammad Bilal b9757447a8
fix(openapi): document webhook secret in API schema (#14199) 
Fixes #13862

Updates the webhook OpenAPI schema to match the current API behavior for
webhook secrets and supported subscription events.

## Why

Current source already creates per-webhook secrets, returns `secret`
from the account webhook API, and uses that secret to sign outbound
webhook requests with `X-Chatwoot-Signature`.

The OpenAPI schema was behind that contract:
- `components.schemas.webhook` did not include the returned `secret`
field.
- Webhook subscription enums did not include the typing events that are
already available in the dashboard webhook form and handled by
`WebhookListener`.

## What this change does

- Documents `secret` on the webhook response schema.
- Documents the outbound webhook signing headers associated with
`secret`: `X-Chatwoot-Timestamp`, `X-Chatwoot-Signature`, and
`X-Chatwoot-Delivery`.
- Adds `conversation_typing_on` and `conversation_typing_off` to webhook
subscription enums.
- Regenerates the main and tag-group swagger JSON files.

## Validation

- Ran `bundle exec rails swagger:build`.
- Ran `bundle exec rspec spec/swagger/openapi_spec.rb`.
- Verified generated swagger JSON includes `secret`,
`conversation_typing_on`, and `conversation_typing_off` in the webhook
schemas.

---------

Co-authored-by: Syed Muhammad Bilal <sdmhbilal@users.noreply.github.com>
Co-authored-by: Sojan Jose <sojan@pepalo.com>
2026-05-22 16:10:17 +05:30
..
extension feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
integrations Fix: Make swagger doc compliant to OpenAPI (#3394) 2021-11-17 18:55:15 +05:30
public docs(swagger): fix public API schema definitions to match jbuilder responses (#13693) 2026-03-19 00:03:37 -07:00
reports feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
account_detail.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
account_show_response.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
account_user.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11374) 2025-05-22 14:26:44 +07:00
account.yml chore: Update API docs (#1153) 2020-08-18 12:14:37 +05:30
agent_bot.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
agent.yml fix: clarify agent availability swagger fields (#14533) 2026-05-22 11:33:19 +05:30
article.yml fix: Help center api doc (#7189) 2023-05-25 18:50:00 +05:30
audit_log.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
automation_rule_item.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
automation_rule.yml feat: Add automation rule event conversation resolved (#9669) 2025-08-13 12:57:14 +05:30
canned_response.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
category.yml fix: Help center api doc (#7189) 2023-05-25 18:50:00 +05:30
contact_conversation_message.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
contact_conversations_response.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contact_detail.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
contact_inbox.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
contact_inboxes.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contact_list_item.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
contact_meta.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
contact_show_response.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contact.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contactable_inboxes_response.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contactable_inboxes.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11374) 2025-05-22 14:26:44 +07:00
contacts_list_response.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
conversation_messages.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
conversation_meta.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
conversation.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
custom_attribute.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
custom_filter.yml Fix: Make swagger doc compliant to OpenAPI (#3394) 2021-11-17 18:55:15 +05:30
inbox_contact.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
inbox.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
label.yml docs(swagger): document account label endpoints (#13760) 2026-03-10 22:24:16 -07:00
message_detailed.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
message.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
platform_account.yml chore: Add Swagger docs for Platform APIs (#2349) 2021-05-31 10:58:43 +05:30
portal_config.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
portal_item.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
portal_logo.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
portal_meta.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
portal_single.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
portal.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
reporting_event_meta.yml feat: allow querying reporting events via the API (#12832) 2025-11-13 12:46:55 +05:30
reporting_event.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
reporting_events_list_response.yml feat: allow querying reporting events via the API (#12832) 2025-11-13 12:46:55 +05:30
team.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
user.yml feat: validate OpenAPI spec using Skooma (#13623) 2026-03-10 18:33:55 -07:00
webhook.yml fix(openapi): document webhook secret in API schema (#14199) 2026-05-22 16:10:17 +05:30