Canto

Canto Webhooks API

Webhooks are used to notify your application when certain events occur within the system. They can be configured to send a POST request to a specified URL when a specific event happens. Available resources and the events they support: - product - created - updated - deleted - variant - created - updated - deleted - import - started - completed - failed You can validate the payload using the +X-Webhook-Signature+ header. It's a SHA256 hash of the payload, signed with the secret key.

GitHub OpenAPI

Operations 6

GET /webhooks Get Webhooks #
POST /webhooks Create Webhook #
GET /webhooks/{id} Get Webhook #
PUT /webhooks/{id} Update Webhook #
DELETE /webhooks/{id} Delete Webhook #
PATCH /webhooks/{id} Update Webhook #

Documentation

📖
Documentation
https://www.canto.com/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/canto/refs/heads/main/openapi/canto-webhooks-api-openapi.yml

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/canto:canto-webhooks-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

canto-webhooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Canto PIM Webhooks API
  description: Canto APIs enable seamless synchronization between the PIM + DAM and external systems that rely on accurate, up-to-date product content.
  version: v1.0.1
servers:
- url: https://{tenantSubdomain}.{region}/api/v1/pim/
  variables:
    tenantSubdomain:
      default: demo
    region:
      enum:
      - canto.com
      - canto.global
      - canto.de
      - au.canto.com
      - ca.canto.com
      default: canto.com
security:
- bearerAuth: []
tags:
- name: Webhooks
  description: 'Webhooks are used to notify your application when certain events occur within the system.

    They can be configured to send a POST request to a specified URL when a specific event happens.

    Available resources and the events they support:

    - product

    - created

    - updated

    - deleted

    - variant

    - created

    - updated

    - deleted

    - import

    - started

    - completed

    - failed


    You can validate the payload using the +X-Webhook-Signature+ header. It''s a SHA256 hash of the payload, signed with the secret key.'
paths:
  /webhooks:
    get:
      tags:
      - Webhooks
      summary: Get Webhooks
      description: List all registered webhooks
      operationId: get_api_v1_webhooks
      responses:
        '200':
          description: List of webhooks
          content:
            '*/*':
              schema:
                required:
                - webhooks
                type: object
                properties:
                  webhooks:
                    type: array
                    description: Array of Webhooks
                    items:
                      type: string
                additionalProperties: false
        '401':
          description: User is not permitted to use the API or Authentication is invalid
          content: {}
        '500':
          description: Something went wrong
          content: {}
    post:
      tags:
      - Webhooks
      summary: Create Webhook
      description: Register a new webhook
      operationId: post_api_v1_webhooks
      requestBody:
        content:
          application/json:
            schema:
              required:
              - event
              - resource
              - url
              type: object
              properties:
                url:
                  type: string
                  description: Webhook URL endpoint (including protocol e.g., https://)
                resource:
                  type: string
                  description: Resource type to monitor
                  enum:
                  - product
                  - variant
                  - import
                event:
                  type: string
                  description: Event to monitor (specific to resource)
                  enum:
                  - created
                  - updated
                  - deleted
                  - started
                  - completed
                  - failed
                active:
                  type: boolean
                  description: Whether webhook is actively sending or disabled
                secret:
                  type: string
                  description: Your secret token for webhook authentication
          multipart/form-data:
            schema:
              required:
              - event
              - resource
              - url
              type: object
              properties:
                url:
                  type: string
                  description: Webhook URL endpoint (including protocol e.g., https://)
                resource:
                  type: string
                  description: Resource type to monitor
                  enum:
                  - product
                  - variant
                  - import
                event:
                  type: string
                  description: Event to monitor (specific to resource)
                  enum:
                  - created
                  - updated
                  - deleted
                  - started
                  - completed
                  - failed
                active:
                  type: boolean
                  description: Whether webhook is actively sending or disabled
                secret:
                  type: string
                  description: Your secret token for webhook authentication
        required: true
      responses:
        '201':
          description: Successfully created Webhook
          content:
            '*/*':
              schema:
                required:
                - active
                - event
                - id
                - resource
                - secret
                - url
                type: object
                properties:
                  id:
                    type: number
                    description: Webhook ID
                  url:
                    type: string
                    description: Webhook URL endpoint (including protocol e.g., https://)
                  resource:
                    type: string
                    description: Resource type to monitor
                    enum:
                    - product
                    - variant
                    - import
                  event:
                    type: string
                    description: Event to monitor (specific to resource)
                    enum:
                    - created
                    - updated
                    - deleted
                    - started
                    - completed
                    - failed
                  active:
                    type: boolean
                    description: Whether webhook is actively sending or disabled
                  secret:
                    type: string
                    description: Secret key that you provided or one we generated (store this securely, there's no way to retrieve it again)
                additionalProperties: false
        '400':
          description: The request parameters were invalid. References to `nil` means empty string or `null` value
          content: {}
        '401':
          description: User is not permitted to use the API or Authentication is invalid
          content: {}
        '422':
          description: There was an error creating your Webhook
          content: {}
        '500':
          description: Something went wrong
          content: {}
  /webhooks/{id}:
    get:
      tags:
      - Webhooks
      summary: Get Webhook
      description: Get details of a specific webhook
      operationId: get_api_v1_webhooks_id
      parameters:
      - name: id
        in: path
        description: Webhook ID
        required: true
        schema:
          type: number
      responses:
        '200':
          description: Webhook details
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/webhook_properties'
        '401':
          description: User is not permitted to use the API or Authentication is invalid
          content: {}
        '404':
          description: Webhook ID not found
          content: {}
        '500':
          description: Something went wrong
          content: {}
    put:
      tags:
      - Webhooks
      summary: Update Webhook
      description: Fully update a webhook
      operationId: put_api_v1_webhooks_id
      parameters:
      - name: id
        in: path
        description: Webhook ID
        required: true
        schema:
          type: number
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: Webhook URL endpoint (including protocol e.g., https://)
                resource:
                  type: string
                  description: Resource type to monitor
                  enum:
                  - product
                  - variant
                  - import
                event:
                  type: string
                  description: Event to monitor (specific to resource)
                  enum:
                  - created
                  - updated
                  - deleted
                  - started
                  - completed
                  - failed
                active:
                  type: boolean
                  description: Whether webhook is actively sending or disabled
                secret:
                  type: string
                  description: Your secret token for webhook authentication
          multipart/form-data:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: Webhook URL endpoint (including protocol e.g., https://)
                resource:
                  type: string
                  description: Resource type to monitor
                  enum:
                  - product
                  - variant
                  - import
                event:
                  type: string
                  description: Event to monitor (specific to resource)
                  enum:
                  - created
                  - updated
                  - deleted
                  - started
                  - completed
                  - failed
                active:
                  type: boolean
                  description: Whether webhook is actively sending or disabled
                secret:
                  type: string
                  description: Your secret token for webhook authentication
      responses:
        '200':
          description: Updated webhook
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/webhook_properties'
        '400':
          description: The request parameters were invalid. References to `nil` means empty string or `null` value
          content: {}
        '401':
          description: User is not permitted to use the API or Authentication is invalid
          content: {}
        '404':
          description: Webhook ID not found
          content: {}
        '422':
          description: There was an error creating your Webhook
          content: {}
        '500':
          description: Something went wrong
          content: {}
    delete:
      tags:
      - Webhooks
      summary: Delete Webhook
      description: Remove a webhook
      operationId: delete_api_v1_webhooks_id
      parameters:
      - name: id
        in: path
        description: Webhook ID
        required: true
        schema:
          type: number
      responses:
        '204':
          description: Webhook successfully deleted
          content: {}
        '401':
          description: User is not permitted to use the API or Authentication is invalid
          content: {}
        '404':
          description: Webhook ID not found
          content: {}
        '422':
          description: There was an error deleting your Webhook
          content: {}
        '500':
          description: Something went wrong
          content: {}
    patch:
      tags:
      - Webhooks
      summary: Update Webhook
      description: Partially update webhook details
      operationId: patch_api_v1_webhooks_id
      parameters:
      - name: id
        in: path
        description: Webhook ID
        required: true
        schema:
          type: number
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: Webhook URL endpoint (including protocol e.g., https://)
                resource:
                  type: string
                  description: Resource type to monitor
                  enum:
                  - product
                  - variant
                  - import
                event:
                  type: string
                  description: Event to monitor (specific to resource)
                  enum:
                  - created
                  - updated
                  - deleted
                  - started
                  - completed
                  - failed
                active:
                  type: boolean
                  description: Whether webhook is actively sending or disabled
                secret:
                  type: string
                  description: Your secret token for webhook authentication
          multipart/form-data:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: Webhook URL endpoint (including protocol e.g., https://)
                resource:
                  type: string
                  description: Resource type to monitor
                  enum:
                  - product
                  - variant
                  - import
                event:
                  type: string
                  description: Event to monitor (specific to resource)
                  enum:
                  - created
                  - updated
                  - deleted
                  - started
                  - completed
                  - failed
                active:
                  type: boolean
                  description: Whether webhook is actively sending or disabled
                secret:
                  type: string
                  description: Your secret token for webhook authentication
      responses:
        '200':
          description: Updated webhook
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/webhook_properties'
        '400':
          description: The request parameters were invalid. References to `nil` means empty string or `null` value
          content: {}
        '401':
          description: User is not permitted to use the API or Authentication is invalid
          content: {}
        '404':
          description: Webhook ID not found
          content: {}
        '422':
          description: There was an error creating your Webhook
          content: {}
        '500':
          description: Something went wrong
          content: {}
components:
  schemas:
    webhook_properties:
      required:
      - active
      - event
      - id
      - resource
      - url
      type: object
      properties:
        id:
          type: number
          description: Webhook ID
        url:
          type: string
          description: Webhook URL endpoint (including protocol e.g., https://)
        resource:
          type: string
          description: Resource type to monitor
          enum:
          - product
          - variant
          - import
        event:
          type: string
          description: Event to monitor (specific to resource)
          enum:
          - created
          - updated
          - deleted
          - started
          - completed
          - failed
        active:
          type: boolean
          description: Whether webhook is actively sending or disabled
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: AccessToken
x-original-swagger-version: '2.0'