Skip to content

Docs drift: https://docs.codat.io/using-the-api/webhooks/event-types #1670

Description

@aevv

The webhook event types documented at https://docs.codat.io/using-the-api/webhooks/event-types do not fully align with the event types defined in our codebase.

What’s wrong

  • The codebase (see Codat.Webhooks.Core/EventTypeEnum.cs and Codat.Webhooks.Api.Contract/EventTypes.cs) defines several event types (e.g., DataConnectionStatusChanged, DataSyncCompleted, DatasetDataChanged, PushOperationStatusChanged, PushOperationTimedOut, NewCompanySynchronized) that are not present in the public documentation.
  • Conversely, the documentation lists event types such as company.created, connection.created, read.completed, and {dataType}.write.successful, which are not defined in the codebase enums.
  • This mismatch can cause confusion for integrators and internal teams regarding which events are actually supported and available.

Evidence (file paths, endpoints, diffs)

  • docs/using-the-api/webhooks/event-types.md
  • Codat.Webhooks.Core/EventTypeEnum.cs
  • Codat.Webhooks.Api.Contract/EventTypes.cs

Proposed fix

  • Audit and reconcile the event types between the documentation and the codebase.
  • Update either the documentation or the codebase to ensure all supported event types are consistently represented.

Acceptance criteria

  • All event types in the documentation are present in the codebase and vice versa.
  • Documentation and codebase are reviewed and signed off by the API and documentation owners.

Unblocked refs:

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions