Codat Webhooks API

Manage webhook consumers for event subscriptions.

Documentation

Specifications

Other Resources

OpenAPI Specification

codat-io-webhooks-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Codat Accounting Webhooks API
  description: Codat's business data API standardizes small-business accounting, banking, and commerce data behind a single integration at api.codat.io, and can write bills, payments, and expenses back into connected platforms. This document consolidates representative endpoints from Codat's Platform, Accounting, Banking, Commerce, Lending, Bank Feeds, Sync for Payables, Sync for Expenses, and Sync for Commerce products. See docs.codat.io and github.com/codatio/oas for the authoritative per-product specifications.
  termsOfService: https://www.codat.io/legal/
  contact:
    name: Codat Support
    url: https://www.codat.io/contact/
  version: '3.0'
servers:
- url: https://api.codat.io
  description: Codat production
security:
- authHeader: []
tags:
- name: Webhooks
  description: Manage webhook consumers for event subscriptions.
paths:
  /webhooks:
    get:
      operationId: listWebhookConsumers
      tags:
      - Webhooks
      summary: List webhook consumers
      responses:
        '200':
          description: OK
    post:
      operationId: createWebhookConsumer
      tags:
      - Webhooks
      summary: Create webhook consumer
      responses:
        '200':
          description: OK
components:
  securitySchemes:
    authHeader:
      type: apiKey
      in: header
      name: Authorization
      description: 'Codat expects your API key Base64-encoded and sent in the Authorization header using the Basic scheme, for example: `Authorization: Basic YOUR_BASE64_ENCODED_API_KEY`.'