Virto Commerce

Virto Commerce Webhooks API

Register HTTP webhooks against the platform domain-event catalog, compose the payload from selected entity properties (including previous values), fire test deliveries, and audit every delivery attempt through the webhook feed.

GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/webhooks/{id} Get a webhook by its ID · Gets VirtoCommerce.WebhooksModule.Core.Models.Webhook by id #
Ask an LLM
“What URL and events is a specific webhook configured with?”
“Can I look up one webhook's settings and success and error counts?”
Tell an agent
Show the configuration of webhook {id}.
Get webhook {id} with its subscribed events.
POST /api/webhooks/feed/search Search webhook delivery logs · Searches webhook logs by certain criteria #
Ask an LLM
“Why did a webhook delivery fail, and where are the logs?”
“Can I filter webhook delivery records by status?”
Tell an agent
Show the delivery log for webhook {webHookIds}.
Find webhook log records with status {statuses}.
DELETE /api/webhooks/feed Delete webhook log entries · Delete webHookFeeds by ids #
Ask an LLM
“How do I clear old webhook delivery log entries?”
“Can I delete specific webhook feed records by ID?”
Tell an agent destructive · confirm first
Delete webhook log entries {ids}.
Purge the webhook feed records with IDs {ids}.
POST /api/webhooks Create or update webhooks · Creates or updates the webhooks #
Ask an LLM
“How do I register a new webhook for platform events?”
“Can I update several webhook definitions in one request?”
Tell an agent
Create a webhook that posts order events to my endpoint.
Save these webhook definitions, updating any that already exist.
DELETE /api/webhooks Delete webhooks · Deletes webhooks by ids #
Ask an LLM
“How do I remove a webhook subscription entirely?”
“Can I delete multiple webhooks in one call?”
Tell an agent destructive · confirm first
Delete webhooks {ids}.
Unregister the webhook with ID {ids}.
POST /api/webhooks/send Send a test request to a webhook · Sends request with given params to webhook and returns result #
Ask an LLM
“Can I fire a webhook manually to test my receiving endpoint?”
“How do I check that a webhook URL with bearer auth responds correctly?”
Tell an agent
Send a test call to webhook URL {url} and show the result.
Test-fire webhook {name} at {url} using bearer token {bearerToken}.
GET /api/webhooks/events List events that can trigger webhooks · Gets all registered events that could trigger webhook notification #
Ask an LLM
“What events can I subscribe a webhook to?”
“Which platform events are registered for webhook notifications?”
Tell an agent
List every event available for webhook subscriptions.
Show me the registered webhook trigger events.
GET /api/webhooks/properties List properties of a webhook event object · Web hooks get event object properties #
Ask an LLM
“Which fields can I include in a webhook payload for an object type?”
“What properties does an event object expose to webhooks?”
Tell an agent
Show the payload properties available for object type {objectType}.
List webhook event fields for {objectType}.

Documentation

📖
Documentation
https://docs.virtocommerce.org/

Specifications

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

SDKs

📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-catalog
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-pricing
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-inventory
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-order
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-x-cart
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-customer
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-marketing
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-quote
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-store
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-platform

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/virto-commerce/refs/heads/main/overlays/virto-commerce-webhooks-api-overlay.yaml
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/virto-commerce/refs/heads/main/graphql/virto-commerce-graphql.md

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/virto-commerce:virto-commerce-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

virto-commerce-webhooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: VirtoCommerce. Webhooks API
  version: v1
  description: Manage user defined webhooks
tags:
- name: Webhooks
  description: Manage user defined webhooks
paths:
  /api/webhooks/{id}:
    get:
      tags:
      - Webhooks
      summary: Gets VirtoCommerce.WebhooksModule.Core.Models.Webhook by id
      operationId: WebHooks_GetWebhookById
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Webhook'
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
            text/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - webhooks:read
      - api_key:
        - webhooks:read
      - api_key_header:
        - webhooks:read
      - http-signature:
        - webhooks:read
      - basic:
        - webhooks:read
      x-virtocommerce-module-id: VirtoCommerce.WebHooks
  /api/webhooks/search:
    post:
      tags:
      - Webhooks
      summary: Searches webhooks by certain criteria
      operationId: WebHooks_Search
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/WebhookSearchCriteria'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/WebhookSearchCriteria'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/WebhookSearchCriteria'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/WebhookSearchResult'
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSearchResult'
            text/json:
              schema:
                $ref: '#/components/schemas/WebhookSearchResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - webhooks:read
      - api_key:
        - webhooks:read
      - api_key_header:
        - webhooks:read
      - http-signature:
        - webhooks:read
      - basic:
        - webhooks:read
      x-virtocommerce-module-id: VirtoCommerce.WebHooks
  /api/webhooks/feed/search:
    post:
      tags:
      - Webhooks
      summary: Searches webhook logs by certain criteria
      operationId: WebHooks_SearchWebhookFeed
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/WebhookFeedSearchCriteria'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/WebhookFeedSearchCriteria'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/WebhookFeedSearchCriteria'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/WebHookFeedSearchResult'
            application/json:
              schema:
                $ref: '#/components/schemas/WebHookFeedSearchResult'
            text/json:
              schema:
                $ref: '#/components/schemas/WebHookFeedSearchResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - webhooks:feed:read
      - api_key:
        - webhooks:feed:read
      - api_key_header:
        - webhooks:feed:read
      - http-signature:
        - webhooks:feed:read
      - basic:
        - webhooks:feed:read
      x-virtocommerce-module-id: VirtoCommerce.WebHooks
  /api/webhooks/feed:
    delete:
      tags:
      - Webhooks
      summary: Delete webHookFeeds by ids
      operationId: WebHooks_DeleteWebHookFeeds
      parameters:
      - name: ids
        in: query
        description: WebHook Feeds ids to delete.
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - webhooks:delete
      - api_key:
        - webhooks:delete
      - api_key_header:
        - webhooks:delete
      - http-signature:
        - webhooks:delete
      - basic:
        - webhooks:delete
      x-virtocommerce-module-id: VirtoCommerce.WebHooks
  /api/webhooks:
    post:
      tags:
      - Webhooks
      summary: Creates or updates the webhooks
      operationId: WebHooks_SaveWebhooks
      requestBody:
        description: Webhooks to save.
        content:
          application/json-patch+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Webhook'
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Webhook'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Webhook'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Webhook'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Webhook'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Webhook'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - webhooks:update
      - api_key:
        - webhooks:update
      - api_key_header:
        - webhooks:update
      - http-signature:
        - webhooks:update
      - basic:
        - webhooks:update
      x-virtocommerce-module-id: VirtoCommerce.WebHooks
    delete:
      tags:
      - Webhooks
      summary: Deletes webhooks by ids
      operationId: WebHooks_DeleteWebHooks
      parameters:
      - name: ids
        in: query
        description: Webhook ids to delete.
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - webhooks:delete
      - api_key:
        - webhooks:delete
      - api_key_header:
        - webhooks:delete
      - http-signature:
        - webhooks:delete
      - basic:
        - webhooks:delete
      x-virtocommerce-module-id: VirtoCommerce.WebHooks
  /api/webhooks/send:
    post:
      tags:
      - Webhooks
      summary: Sends request with given params to webhook and returns result
      operationId: WebHooks_Run
      requestBody:
        description: Request params.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Webhook'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Webhook'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Webhook'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/WebhookSendResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSendResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/WebhookSendResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.WebHooks
  /api/webhooks/events:
    get:
      tags:
      - Webhooks
      summary: Gets all registered events that could trigger webhook notification
      operationId: WebHooks_GetAllRegisteredEvents
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RegisteredEvent'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RegisteredEvent'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RegisteredEvent'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - webhooks:read
      - api_key:
        - webhooks:read
      - api_key_header:
        - webhooks:read
      - http-signature:
        - webhooks:read
      - basic:
        - webhooks:read
      x-virtocommerce-module-id: VirtoCommerce.WebHooks
  /api/webhooks/properties:
    get:
      tags:
      - Webhooks
      operationId: WebHooks_GetEventObjectProperties
      parameters:
      - name: objectType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/EventObjectProperties'
            application/json:
              schema:
                $ref: '#/components/schemas/EventObjectProperties'
            text/json:
              schema:
                $ref: '#/components/schemas/EventObjectProperties'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - webhooks:read
      - api_key:
        - webhooks:read
      - api_key_header:
        - webhooks:read
      - http-signature:
        - webhooks:read
      - basic:
        - webhooks:read
      x-virtocommerce-module-id: VirtoCommerce.WebHooks
      summary: Web hooks get event object properties
      x-summary-source: derived
components:
  schemas:
    AuthenticationType:
      enum:
      - None
      - Basic
      - BearerToken
      - CustomHeader
      type: string
    EventObjectProperties:
      type: object
      properties:
        discovered:
          type: boolean
        properties:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    WebhookFeedEntry:
      type: object
      properties:
        webHookId:
          type:
          - string
          - 'null'
        eventId:
          type:
          - string
          - 'null'
        attemptCount:
          type: integer
          format: int32
        status:
          type: integer
          format: int32
        recordType:
          type: integer
          format: int32
        error:
          type:
          - string
          - 'null'
        requestHeaders:
          type:
          - string
          - 'null'
        requestBody:
          type:
          - string
          - 'null'
        responseHeaders:
          type:
          - string
          - 'null'
        responseBody:
          type:
          - string
          - 'null'
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type:
          - string
          - 'null'
          format: date-time
        createdBy:
          maxLength: 64
          minLength: 0
          type:
          - string
          - 'null'
        modifiedBy:
          maxLength: 64
          minLength: 0
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
      additionalProperties: false
    RegisteredEvent:
      type: object
      properties:
        eventType:
          type:
          - string
          - 'null'
        displayName:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
      additionalProperties: false
    WebhookSearchResult:
      type: object
      properties:
        totalCount:
          type: integer
          format: int32
        results:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Webhook'
      additionalProperties: false
    WebhookFeedSearchCriteria:
      type: object
      properties:
        webHookIds:
          type:
          - array
          - 'null'
          items:
            type: string
        eventIds:
          type:
          - array
          - 'null'
          items:
            type: string
        statuses:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        recordTypes:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        responseGroup:
          type:
          - string
          - 'null'
        objectType:
          type:
          - string
          - 'null'
        objectTypes:
          type:
          - array
          - 'null'
          items:
            type: string
        objectIds:
          type:
          - array
          - 'null'
          items:
            type: string
        keyword:
          type:
          - string
          - 'null'
        searchPhrase:
          type:
          - string
          - 'null'
        languageCode:
          type:
          - string
          - 'null'
        sort:
          type:
          - string
          - 'null'
        sortInfos:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SortInfo'
          readOnly: true
        skip:
          type: integer
          format: int32
        take:
          type: integer
          format: int32
      additionalProperties: false
    WebhookEvent:
      type: object
      properties:
        webHookId:
          type:
          - string
          - 'null'
        eventId:
          type:
          - string
          - 'null'
        displayName:
          type:
          - string
          - 'null'
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type:
          - string
          - 'null'
          format: date-time
        createdBy:
          maxLength: 64
          minLength: 0
          type:
          - string
          - 'null'
        modifiedBy:
          maxLength: 64
          minLength: 0
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
      additionalProperties: false
    WebHookPayload:
      type: object
      properties:
        eventPropertyName:
          type:
          - string
          - 'null'
        webHookId:
          type:
          - string
          - 'null'
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type:
          - string
          - 'null'
          format: date-time
        createdBy:
          maxLength: 64
          minLength: 0
          type:
          - string
          - 'null'
        modifiedBy:
          maxLength: 64
          minLength: 0
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
      additionalProperties: false
    WebhookHttpParams:
      type: object
      properties:
        headers:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
        body:
          type:
          - string
          - 'null'
      additionalProperties: false
    WebhookSendResponse:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
        error:
          type:
          - string
          - 'null'
        responseParams:
          allOf:
          - $ref: '#/components/schemas/WebhookHttpParams'
        isSuccessfull:
          type: boolean
      additionalProperties: false
    Webhook:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        url:
          type:
          - string
          - 'null'
        contentType:
          type:
          - string
          - 'null'
        authType:
          allOf:
          - $ref: '#/components/schemas/AuthenticationType'
        basicUsername:
          type:
          - string
          - 'null'
        basicPassword:
          type:
          - string
          - 'null'
        bearerToken:
          type:
          - string
          - 'null'
        customHttpHeaderName:
          type:
          - string
          - 'null'
        customHttpHeaderValue:
          type:
          - string
          - 'null'
        isActive:
          type: boolean
        successCount:
          type: integer
          format: int64
        errorCount:
          type: integer
          format: int64
        events:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/WebhookEvent'
        requestParams:
          allOf:
          - $ref: '#/components/schemas/WebhookHttpParams'
        payloads:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/WebHookPayload'
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type:
          - string
          - 'null'
          format: date-time
        createdBy:
          maxLength: 64
          minLength: 0
          type:
          - string
          - 'null'
        modifiedBy:
          maxLength: 64
          minLength: 0
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
      additionalProperties: false
    SortInfo:
      type: object
      properties:
        sortColumn:
          type:
          - string
          - 'null'
        sortDirection:
          allOf:
          - $ref: '#/components/schemas/SortDirection'
      additionalProperties: false
    WebhookSearchCriteria:
      type: object
      properties:
        isActive:
          type:
          - boolean
          - 'null'
        eventIds:
          type:
          - array
          - 'null'
          items:
            type: string
        responseGroup:
          type:
          - string
          - 'null'
        objectType:
          type:
          - string
          - 'null'
        objectTypes:
          type:
          - array
          - 'null'
          items:
            type: string
        objectIds:
          type:
          - array
          - 'null'
          items:
            type: string
        keyword:
          type:
          - string
          - 'null'
        searchPhrase:
          type:
          - string
          - 'null'
        languageCode:
          type:
          - string
          - 'null'
        sort:
          type:
          - string
          - 'null'
        sortInfos:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SortInfo'
          readOnly: true
        skip:
          type: integer
          format: int32
        take:
          type: integer
          format: int32
      additionalProperties: false
    SortDirection:
      enum:
      - Ascending
      - Descending
      type: string
    WebHookFeedSearchResult:
      type: object
      properties:
        totalCount:
          type: integer
          format: int32
        results:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/WebhookFeedEntry'
      additionalProperties: false
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth2 Resource Owner Password Grant flow
      flows:
        password:
          tokenUrl: /connect/token
          scopes: {}
        clientCredentials:
          tokenUrl: /connect/token
          scopes: {}
    api_key:
      type: apiKey
      description: API Key authentication
      name: api_key
      in: query
    api_key_header:
      type: apiKey
      description: API Key authentication (alternative via header)
      name: api_key
      in: header
    http-signature:
      type: http
      description: HTTP Signature authentication using Authorization header
      scheme: signature
    basic:
      type: http
      description: Basic authentication using username and password
      scheme: basic