Smartcat

Smartcat Callback API

The Callback API from Smartcat — 2 operation(s) for callback.

GitHub OpenAPI

Operations 4

GET /api/integration/v1/callback Fetch the notifications settings for the account #
POST /api/integration/v1/callback Create or update the notifications settings #
DELETE /api/integration/v1/callback Delete notifications settings #
GET /api/integration/v1/callback/lastErrors Fetch the latest delivery errors #

Documentation

📖
Authentication
https://artifacts.apis.io/smartcat/authentication/smartcat-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/smartcat/openapi/smartcat-callback-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://artifacts.apis.io/smartcat/errors/smartcat-problem-types.yml
🔗
Conventions
https://artifacts.apis.io/smartcat/conventions/smartcat-conventions.yml
🔗
Idempotency
https://artifacts.apis.io/smartcat/conventions/smartcat-conventions.yml
🔗
DataModel
https://artifacts.apis.io/smartcat/data-model/smartcat-data-model.yml
🔗
Webhooks
https://artifacts.apis.io/smartcat/asyncapi/smartcat-callbacks-webhooks.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/smartcat:smartcat-callback-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

smartcat-callback-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Smartcat Callback API
  version: v1
servers:
- url: /
tags:
- name: Callback
paths:
  /api/integration/v1/callback:
    get:
      tags:
      - Callback
      summary: Fetch the notifications settings for the account
      responses:
        '200':
          description: Notifications settings have been successfully fetched
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CallbackPropertyModel'
            application/json:
              schema:
                $ref: '#/components/schemas/CallbackPropertyModel'
            text/json:
              schema:
                $ref: '#/components/schemas/CallbackPropertyModel'
        '404':
          description: Notifications settings are not configured
      operationId: getApiIntegrationV1Callback
      x-operation-id-source: derived
    post:
      tags:
      - Callback
      summary: Create or update the notifications settings
      requestBody:
        description: Notifications settings
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/CallbackPropertyModel'
          application/json:
            schema:
              $ref: '#/components/schemas/CallbackPropertyModel'
          text/json:
            schema:
              $ref: '#/components/schemas/CallbackPropertyModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CallbackPropertyModel'
        required: true
      responses:
        '200':
          description: Notifications settings have been successfully updated
        '400':
          description: 'Returns if:

            - URI is invalid

            - a header Smartcat.AppIntegrations.Contracts.AdditionalHeaderModel.Name is empty or null, or consists of space characters only

            - a header Smartcat.AppIntegrations.Contracts.AdditionalHeaderModel.Value is null

            - a header is formatted incorrectly, that is requires coding or does not conform to special requirements (such as the authorization header)'
      operationId: postApiIntegrationV1Callback
      x-operation-id-source: derived
    delete:
      tags:
      - Callback
      summary: Delete notifications settings
      responses:
        '204':
          description: Notifications settings have been successfully deleted
      operationId: deleteApiIntegrationV1Callback
      x-operation-id-source: derived
  /api/integration/v1/callback/lastErrors:
    get:
      tags:
      - Callback
      summary: Fetch the latest delivery errors
      parameters:
      - name: limit
        in: query
        description: Maximum returned errors (no more than 100)
        schema:
          type: integer
          format: int32
          default: 100
      responses:
        '200':
          description: The latest errors have been successfully fetched
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CallbackErrorModel'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CallbackErrorModel'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CallbackErrorModel'
        '400':
          description: The provided limit exceeds the maximum
      operationId: getApiIntegrationV1CallbackLastErrors
      x-operation-id-source: derived
components:
  schemas:
    AdditionalHeaderModel:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Header name
        value:
          type:
          - string
          - 'null'
          description: Value
      additionalProperties: false
      description: User header model
    CallbackPropertyModel:
      type: object
      properties:
        url:
          type:
          - string
          - 'null'
          description: URL for receiving notifications
        additionalHeaders:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AdditionalHeaderModel'
          description: Additional headers array
      additionalProperties: false
      description: Notification properties change model
    CallbackErrorModel:
      type: object
      properties:
        created:
          type: string
          description: Callback send time
          format: date-time
        url:
          type:
          - string
          - 'null'
          description: Request URL
        reason:
          type:
          - string
          - 'null'
          description: Request failure reason
        code:
          type:
          - integer
          - 'null'
          description: Server response code
          format: int32
        content:
          type:
          - string
          - 'null'
          description: Server response content
        sourceIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of event source IDs
      additionalProperties: false
      description: Callback error description