Karbon

Karbon Webhook Payloads API

Details of the different payloads sent for Karbon Webhook subscriptions

Documentation GitHub OpenAPI

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/karbonhq:karbonhq-webhook-payloads-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Karbonhq Webhook Payloads API
  version: v3
  contact:
    name: API Support
    url: https://developers.karbonhq.com/issues/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://karbonhq.com/terms-of-use/
  description: 'Operations tagged Webhook Payloads across 2 of this provider''s published API definitions: KarbonAPI.json, karbonhq-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.karbonhq.com
  description: The production API server
security:
- ApiKeyAuth: []
  BearerAuth: []
tags:
- name: Webhook Payloads
  description: Details of the different payloads sent for Karbon Webhook subscriptions
paths: {}
webhooks:
  contact:
    post:
      tags:
      - Webhook Payloads
      description: Contact created or updated
      parameters:
      - $ref: '#/components/parameters/WebhookRequestHeader'
      requestBody:
        description: Information about the created or updated contact
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/contact-webhook'
      summary: Create contact
      x-summary-source: derived
    servers:
    - url: https://api.karbonhq.com
      description: The production API server
  customfield:
    post:
      tags:
      - Webhook Payloads
      description: Custom field value added or updated
      parameters:
      - $ref: '#/components/parameters/WebhookRequestHeader'
      requestBody:
        description: Information about the created or updated custom field value
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/customfield-webhook'
      summary: Create customfield
      x-summary-source: derived
    servers:
    - url: https://api.karbonhq.com
      description: The production API server
  estimate-summary:
    post:
      tags:
      - Webhook Payloads
      description: Estimate Summary updated
      parameters:
      - $ref: '#/components/parameters/WebhookRequestHeader'
      requestBody:
        description: Information about the updated Estimate Summary
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/estimate-summary-webhook'
      summary: Create estimate summary
      x-summary-source: derived
    servers:
    - url: https://api.karbonhq.com
      description: The production API server
  integration-task:
    post:
      tags:
      - Webhook Payloads
      description: Integration Task created
      parameters:
      - $ref: '#/components/parameters/WebhookRequestHeader'
      requestBody:
        description: Information about an Integration Task that has been added to Work Item
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/integration-task-webhook'
      summary: Create integration task
      x-summary-source: derived
    servers:
    - url: https://api.karbonhq.com
      description: The production API server
  invoice:
    post:
      tags:
      - Webhook Payloads
      description: Invoice status updated
      parameters:
      - $ref: '#/components/parameters/WebhookRequestHeader'
      requestBody:
        description: Information about the created or updated Invoice
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/invoice-webhook'
      summary: Create invoice
      x-summary-source: derived
    servers:
    - url: https://api.karbonhq.com
      description: The production API server
  note:
    post:
      tags:
      - Webhook Payloads
      description: Note created or updated
      parameters:
      - $ref: '#/components/parameters/WebhookRequestHeader'
      requestBody:
        description: Information about the created or updated Note
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/note-webhook'
      summary: Create note
      x-summary-source: derived
    servers:
    - url: https://api.karbonhq.com
      description: The production API server
  note-comment:
    post:
      tags:
      - Webhook Payloads
      description: Note Comment created or updated
      parameters:
      - $ref: '#/components/parameters/WebhookRequestHeader'
      requestBody:
        description: Information about the created or updated Note Comment
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/note-comment-webhook'
      summary: Create note comment
      x-summary-source: derived
    servers:
    - url: https://api.karbonhq.com
      description: The production API server
  user:
    post:
      tags:
      - Webhook Payloads
      description: User has accepted Karbon invite
      parameters:
      - $ref: '#/components/parameters/WebhookRequestHeader'
      requestBody:
        description: Information about the user who has accepted their invite
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/user-webhook'
      summary: Create user
      x-summary-source: derived
    servers:
    - url: https://api.karbonhq.com
      description: The production API server
  work:
    post:
      tags:
      - Webhook Payloads
      description: Work created or updated
      parameters:
      - $ref: '#/components/parameters/WebhookRequestHeader'
      requestBody:
        description: Information about the created or updated WorkItem
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/work-webhook'
      summary: Create work
      x-summary-source: derived
    servers:
    - url: https://api.karbonhq.com
      description: The production API server
  batch:
    post:
      tags:
      - Webhook Payloads
      description: Batch of resource changes
      parameters:
      - $ref: '#/components/parameters/WebhookRequestHeader'
      requestBody:
        description: A batch of resource-change events
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/webhook-batch'
      summary: Create batch
      x-summary-source: derived
    servers:
    - url: https://api.karbonhq.com
      description: The production API server
components:
  schemas:
    customfield-webhook:
      description: The schema for Custom Field webhook payloads
      type: object
      properties:
        ResourcePermaKey:
          type: string
          description: The unique key of the custom field value that was created or updated
          example: kCsVf7svWQw
          readOnly: true
        ResourceType:
          type: string
          enum:
          - CustomFieldValue
          description: The type of resource that has been created or updated
          example: CustomFieldValue
          readOnly: true
        ActionType:
          type: string
          description: The action that triggered the webhook notification to be sent
          enum:
          - Inserted
          - Updated
          example: Updated
          readOnly: true
        TimeStamp:
          type: string
          format: date-time
          description: The timestamp the associated resource was last altered
          example: '2024-08-01T21:54:36Z'
          readOnly: true
        ClientKey:
          type: string
          description: The unique key for the client related to the custom field
          example: 44dSBb94ZXlR
          readOnly: true
        ClientType:
          type: string
          description: Indicates whether the custom field value belongs to a Contact or an Organization
          enum:
          - Contact
          - Organization
          example: Organization
          readOnly: true
    estimate-summary-webhook:
      description: The schema for EstimateSummary webhook payloads
      type: object
      properties:
        ResourcePermaKey:
          type: string
          description: The key for the resource that has been created or updated
          example: kCsVf7svWQw
          readOnly: true
        ResourceType:
          type: string
          enum:
          - Estimate
          description: The type of resource that has been created or updated
          example: Estimate
          readOnly: true
        ActionType:
          type: string
          description: The action that triggered the webhook notification to be sent
          enum:
          - Updated
          example: Updated
          readOnly: true
        TimeStamp:
          type: string
          format: date-time
          description: The timestamp the associated resource was last altered
          example: '2024-08-01T21:54:36Z'
          readOnly: true
    webhook-batch:
      description: The schema for a batched webhook delivery, sent instead of a single-event payload when a Webhook Subscription has `BatchSize` set to more than 1
      type: object
      properties:
        BatchId:
          type: string
          format: uuid
          description: A unique identifier for this batch
          example: 70575b82-9a31-4576-a4e7-61e20c42189d
          readOnly: true
        Count:
          type: integer
          description: The number of events in this batch
          example: 3
          readOnly: true
        Events:
          type: array
          description: The events in this batch, in the order they occurred
          items:
            $ref: '#/components/schemas/webhook-batch-event'
    note-webhook:
      description: The schema for Note webhook payloads
      type: object
      properties:
        ResourcePermaKey:
          type: string
          description: The key for the resource that has been created or updated
          example: kCsVf7svWQw
          readOnly: true
        ResourceType:
          type: string
          enum:
          - Note
          description: The type of resource that has been created or updated
          example: Note
          readOnly: true
        ActionType:
          type: string
          description: The action that triggered the webhook notification to be sent
          enum:
          - Inserted
          - Updated
          - Deleted
          example: Updated
          readOnly: true
        TimeStamp:
          type: string
          format: date-time
          description: The timestamp the associated resource was last altered
          example: '2024-08-01T21:54:36Z'
          readOnly: true
    webhook-batch-event:
      description: A single resource-change event within a batched webhook delivery
      type: object
      properties:
        ResourcePermaKey:
          type: string
          description: The key for the resource that has been created or updated
          example: 3GBF6TnYRc7C
          readOnly: true
        ResourceType:
          type: string
          description: The type of resource that has been created or updated. Note this uses `WorkItem`, not `Work` as used elsewhere for this resource type.
          example: WorkItem
          readOnly: true
        ActionType:
          type: string
          description: The action that triggered the event
          enum:
          - Inserted
          - Updated
          - Deleted
          example: Inserted
          readOnly: true
        Timestamp:
          type: string
          format: date-time
          description: The timestamp the associated resource was altered. Note the casing differs from `TimeStamp` on the single-event payloads above.
          example: '2026-09-02T03:49:42Z'
          readOnly: true
    contact-webhook:
      description: The schema for Contact webhook payloads
      type: object
      properties:
        ResourcePermaKey:
          type: string
          description: The key for the resource that has been created or updated
          example: kCsVf7svWQw
          readOnly: true
        ResourceType:
          type: string
          enum:
          - Contact
          description: The type of resource that has been created or updated
          example: Contact
          readOnly: true
        ActionType:
          type: string
          description: The action that triggered the webhook notification to be sent
          enum:
          - Inserted
          - Updated
          - Deleted
          example: Updated
          readOnly: true
        TimeStamp:
          type: string
          format: date-time
          description: The timestamp the associated resource was last altered
          example: '2024-08-01T21:54:36Z'
          readOnly: true
    user-webhook:
      description: The schema for User webhook payloads
      type: object
      properties:
        ResourcePermaKey:
          type: string
          description: The key for the resource that has been created
          example: kCsVf7svWQw
          readOnly: true
        ResourceType:
          type: string
          enum:
          - User
          description: The type of resource that has been created
          example: User
          readOnly: true
        ActionType:
          type: string
          description: The action that triggered the webhook notification to be sent
          enum:
          - Inserted
          example: Inserted
          readOnly: true
        TimeStamp:
          type: string
          format: date-time
          description: The timestamp the associated resource was last altered
          example: '2024-08-01T21:54:36Z'
          readOnly: true
    invoice-webhook:
      description: The schema for Invoice webhook payloads
      type: object
      properties:
        ResourcePermaKey:
          type: string
          description: The key for the resource that has been created or updated
          example: kCsVf7svWQw
          readOnly: true
        ResourceType:
          type: string
          enum:
          - Invoice
          description: The type of resource that has been created or updated
          example: Invoice
          readOnly: true
        ActionType:
          type: string
          description: The action that triggered the webhook notification to be sent
          enum:
          - Updated
          example: Updated
          readOnly: true
        TimeStamp:
          type: string
          format: date-time
          description: The timestamp the associated resource was last altered
          example: '2024-08-01T21:54:36Z'
          readOnly: true
    work-webhook:
      description: The schema for Work webhook payloads
      type: object
      properties:
        ResourcePermaKey:
          type: string
          description: The key for the resource that has been created or updated
          example: kCsVf7svWQw
          readOnly: true
        ResourceType:
          type: string
          enum:
          - Work
          description: The type of resource that has been created or updated
          example: Work
          readOnly: true
        ActionType:
          type: string
          description: The action that triggered the webhook notification to be sent
          enum:
          - Inserted
          - Updated
          - Deleted
          example: Updated
          readOnly: true
        TimeStamp:
          type: string
          format: date-time
          description: The timestamp the associated resource was last altered
          example: '2024-08-01T21:54:36Z'
          readOnly: true
    integration-task-webhook:
      description: The schema for Integration Task webhook payloads
      type: object
      properties:
        ResourcePermaKey:
          type: string
          description: The key for the resource that has been created or updated
          example: kCsVf7svWQw
          readOnly: true
        ResourceType:
          type: string
          enum:
          - IntegrationTask
          description: The type of resource that has been created or updated
          example: IntegrationTask
          readOnly: true
        ActionType:
          type: string
          description: The action that triggered the webhook notification to be sent
          enum:
          - Inserted
          example: Inserted
          readOnly: true
        TimeStamp:
          type: string
          format: date-time
          description: The timestamp the associated resource was last altered
          example: '2024-08-01T21:54:36Z'
          readOnly: true
        ClientKey:
          type: string
          description: The key for the client related to the integration task
          example: 44dSBb94ZXlR
          readOnly: true
        ClientType:
          type: string
          description: 'The type of client related to the integration task '
          enum:
          - Contact
          - Organization
          example: Organization
          readOnly: true
        WorkItemKey:
          type: string
          description: The key for the Work Item that the Integration Task was added to
          example: qkG7YMW541L
          readOnly: true
    note-comment-webhook:
      description: The schema for Note webhook payloads
      type: object
      properties:
        ResourcePermaKey:
          type: string
          description: The key for the resource that has been created or updated
          example: kCsVf7svWQw
          readOnly: true
        ResourceType:
          type: string
          enum:
          - NoteComment
          description: The type of resource that has been created or updated
          example: NoteComment
          readOnly: true
        ActionType:
          type: string
          description: The action that triggered the webhook notification to be sent
          enum:
          - Inserted
          - Updated
          - Deleted
          example: Updated
          readOnly: true
        TimeStamp:
          type: string
          format: date-time
          description: The timestamp the associated resource was last altered
          example: '2024-08-01T21:54:36Z'
          readOnly: true
        ParentEntityType:
          type: string
          enum:
          - Note
          description: The resource type of the parent entity the note comment was created on
          example: Note
          readOnly: true
        ParentEntityKey:
          type: string
          description: The key for the parent of the resource that has been created or updated
          example: 2TTFWz8L5SSt
          readOnly: true
  parameters:
    WebhookRequestHeader:
      in: header
      name: Signature
      schema:
        type: string
      examples:
        WebhookPayloadSignature:
          value: Signed webhook payload
          summary: 8c42dd0e4779a2e8a56d3b8ef962238ca26f95ddc2d9abb0e76f04991a3442f3
      description: The HMAC signature generated when a webhook subscription payload includes the SigningKey property
  securitySchemes:
    BearerAuth:
      description: The Application ID for your API application, supplied by secure message when your Application is first registered
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      description: The AccessKey for your API application, found inside the Settings > Connected Apps section in Karbon
      type: apiKey
      in: header
      name: AccessKey
externalDocs:
  description: Karbon Developers - API release notes
  url: https://developers.karbonhq.com/release-notes/
x-refined-from:
- KarbonAPI.json
- karbonhq-openapi.yml