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/subotiz-com:subotiz-com-webhook-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: Subotiz Com Webhook API
  version: 1.0.0
  description: 'Operations tagged Webhook across 2 of this provider''s published API definitions: subotiz-com-openapi.yml, v1-en.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{api}.subotiz.com
  variables:
    api:
      default: api
security:
- sec0: []
tags:
- name: Webhook
paths:
  /api/v1/webhook-event:
    get:
      tags:
      - Webhook
      summary: List Webhook Events
      description: Returns a list of webhook events created via the API only when the callback_url was specified in the request.
      operationId: v1-webhook-list-webhook-event
      parameters:
      - name: business_ids
        in: query
        description: Business ID array, filter webhook events whose business IDs belong to this array
        schema:
          type: array
          items:
            type: string
      - name: event_type
        in: query
        description: Event type array, filter webhook events whose event types belong to this array
        schema:
          type: array
          items:
            type: string
      - name: event_status
        in: query
        description: Event status array, filter webhook events whose event status belong to this array
        schema:
          type: array
          items:
            type: string
      - name: starting_after
        in: query
        description: Cursor for pagination. `starting_after` is the object ID that defines your position in the list. For example, if you want to get the next page, you can use the last object's ID as the parameter value after getting the object list for the first time. Cannot be used together with `ending_before`
        schema:
          type: string
      - name: ending_before
        in: query
        description: Cursor for pagination. `ending_before` is the object ID that defines your position in the list. For example, if you want to get the previous page, you can use the first object's ID as the parameter value after getting the object list for the first time. Cannot be used together with `starting_after`
        schema:
          type: string
      - name: limit
        in: query
        description: 'Pagination parameter, number of items per page, default: 10, interface defaults to sorting by creation time in descending order. Limit: [1, 100]'
        schema:
          type: integer
          format: int32
      - $ref: '#/components/parameters/HeaderRequestID'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebhookEventResponse'
      deprecated: true
    servers:
    - url: https://{api}.subotiz.com
      variables:
        api:
          default: api
  /api/v2/webhook/endpoints:
    get:
      tags:
      - Webhook
      summary: List Webhook Endpoints
      operationId: v1-webhook-list-endpoint
      parameters:
      - name: starting_after
        in: query
        description: Cursor for pagination. `starting_after` is the object ID that defines your position in the list. For example, if you want to get the next page, you can use the last object's ID as the parameter value after getting the object list for the first time. Cannot be used together with `ending_before`
        schema:
          type: string
      - name: ending_before
        in: query
        description: Cursor for pagination. `ending_before` is the object ID that defines your position in the list. For example, if you want to get the previous page, you can use the first object's ID as the parameter value after getting the object list for the first time. Cannot be used together with `starting_after`
        schema:
          type: string
      - name: limit
        in: query
        description: 'Pagination parameter, number of items per page, default: 10, interface defaults to sorting by creation time in descending order. Limit: [1, 100]'
        schema:
          type: integer
          format: int32
      - name: status
        in: query
        description: Endpoint status array, filter webhook endpoint whose status belong to this array
        schema:
          type: array
          items:
            type: string
      - name: created_at.gt
        in: query
        description: Minimum value to filter by (exclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
        schema:
          type: string
      - name: created_at.gte
        in: query
        description: Minimum value to filter by (inclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
        schema:
          type: string
      - name: created_at.lt
        in: query
        description: Maximum value to filter by (exclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
        schema:
          type: string
      - name: created_at.lte
        in: query
        description: Maximum value to filter by (inclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
        schema:
          type: string
      - $ref: '#/components/parameters/HeaderRequestID'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEndpointResponse'
    servers:
    - url: https://{api}.subotiz.com
      variables:
        api:
          default: api
  /api/v2/webhook/events:
    get:
      tags:
      - Webhook
      summary: List Webhook Events V2
      description: Returns a list of webhook events created with configured endpoints.
      operationId: v2-webhook-list-event
      parameters:
      - name: business_ids
        in: query
        description: Business ID array, filter webhook events whose business IDs belong to this array
        schema:
          type: array
          items:
            type: string
      - name: event_type
        in: query
        description: Event type array, filter webhook events whose event types belong to this array
        schema:
          type: array
          items:
            type: string
      - name: event_status
        in: query
        description: Event status array, filter webhook events whose event status belong to this array
        schema:
          type: array
          items:
            type: string
      - name: starting_after
        in: query
        description: Cursor for pagination. `starting_after` is the object ID that defines your position in the list. For example, if you want to get the next page, you can use the last object's ID as the parameter value after getting the object list for the first time. Cannot be used together with `ending_before`
        schema:
          type: string
      - name: ending_before
        in: query
        description: Cursor for pagination. `ending_before` is the object ID that defines your position in the list. For example, if you want to get the previous page, you can use the first object's ID as the parameter value after getting the object list for the first time. Cannot be used together with `starting_after`
        schema:
          type: string
      - name: limit
        in: query
        description: 'Pagination parameter, number of items per page, default: 10, interface defaults to sorting by creation time in descending order. Limit: [1, 100]'
        schema:
          type: integer
          format: int32
      - name: created_at.gt
        in: query
        description: Minimum value to filter by (exclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
        schema:
          type: string
      - name: created_at.gte
        in: query
        description: Minimum value to filter by (inclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
        schema:
          type: string
      - name: created_at.lt
        in: query
        description: Maximum value to filter by (exclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
        schema:
          type: string
      - name: created_at.lte
        in: query
        description: Maximum value to filter by (inclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
        schema:
          type: string
      - $ref: '#/components/parameters/HeaderRequestID'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebhookEventV2Response'
    servers:
    - url: https://{api}.subotiz.com
      variables:
        api:
          default: api
components:
  parameters:
    HeaderRequestID:
      name: Request-Id
      in: header
      description: The unique identifier of the request
      required: true
      schema:
        type: string
        default: 008e3967-a1b5-48bb-be14-d5bff5092e61
  schemas:
    ListEndpointResponse_Data:
      type: object
      properties:
        has_more:
          type: boolean
          description: Whether there is more data
        list:
          type: array
          items:
            $ref: '#/components/schemas/Endpoint'
          description: Webhook Endpoint list
    Endpoint:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the webhook endpoint
        url:
          type: string
          description: Webhook callback URL
        desc:
          type: string
          description: Endpoint description
        event_version:
          type: string
          description: Event version
        all_events:
          type: boolean
          description: Whether to receive all events
        event_types:
          type: array
          items:
            type: string
          description: Specific event types to be received
        status:
          type: string
          description: Endpoint status (enabled or disabled)
    WebhookEvent:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the webhook event
        business_id:
          type: string
          description: Business identifier associated with the event
        event_type:
          type: string
          description: 'Event type

            - invoice.payment_failed: Triggered when invoice payment fails

            - invoice.paid: Triggered when invoice payment succeeds

            - subscription.trial_period_expiring: Triggered when subscription trial period is about to expire

            - subscription.first: Triggered when subscription first payment succeeds

            - subscription.canceled: Triggered when subscription is canceled

            - subscription.price_changed: Triggered when subscription price is changed

            - trades.succeeded: Triggered when trade payment succeeds

            - trades.payment_failed: Triggered when trade payment fails

            - refunds.succeeded: Triggered when refund succeeds

            - refunds.failed: Triggered when refund fails'
        event_status:
          type: string
          description: 'Event delivery status

            - pending: Event is pending delivery

            - success: Event delivered successfully

            - failed: Event delivery failed'
        url:
          type: string
          description: Webhook callback URL
        content:
          type: string
          description: Event payload content, JSON-encoded string containing event-specific data
    ListWebhookEventV2Response_Data:
      type: object
      properties:
        has_more:
          type: boolean
          description: Whether there is more data
        list:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventV2'
          description: Webhook event list
    ListWebhookEventV2Response:
      type: object
      properties:
        code:
          type: string
          description: error code
        message:
          type: string
          description: error message
        data:
          $ref: '#/components/schemas/ListWebhookEventV2Response_Data'
    ListEndpointResponse:
      type: object
      properties:
        code:
          type: string
          description: error code
        message:
          type: string
          description: error message
        data:
          $ref: '#/components/schemas/ListEndpointResponse_Data'
    EndpointEvent:
      type: object
      properties:
        endpoint_id:
          type: string
          description: Unique identifier for the webhook endpoint
        url:
          type: string
          description: Webhook callback URL
        event_status:
          type: string
          description: 'Event delivery status

            - pending: Event is pending delivery

            - success: Event delivered successfully

            - failed: Event delivery failed'
    ListWebhookEventResponse:
      type: object
      properties:
        code:
          type: string
          description: error code
        message:
          type: string
          description: error message
        data:
          $ref: '#/components/schemas/ListWebhookEventResponse_Data'
    WebhookEventV2:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the webhook event
        business_id:
          type: string
          description: Business identifier associated with the event
        event_type:
          type: string
          description: Event type
        content:
          type: string
          description: Event payload content, JSON-encoded string containing event-specific data
        endpoint_events:
          type: array
          items:
            $ref: '#/components/schemas/EndpointEvent'
          description: Delivery status for each endpoint
    ListWebhookEventResponse_Data:
      type: object
      properties:
        has_more:
          type: boolean
          description: Whether there is more data
        list:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEvent'
          description: Webhook event list
  securitySchemes:
    sec0:
      type: http
      description: 'Bearer API Key authentication. Format: Authorization: Bearer {your_api_key}'
      scheme: bearer
x-refined-from:
- subotiz-com-openapi.yml
- v1-en.yaml