Convoy

Convoy Subscriptions API

Subscription related APIs

GitHub OpenAPI

Operations 8

POST /v1/projects/{projectID}/sources/test_function Validate Source Function
GET /v1/projects/{projectID}/subscriptions List All Subscriptions #
POST /v1/projects/{projectID}/subscriptions Create a Subscription #
POST /v1/projects/{projectID}/subscriptions/test_filter Validate Subscription Filter #
POST /v1/projects/{projectID}/subscriptions/test_function Test a Subscription Function #
DELETE /v1/projects/{projectID}/subscriptions/{subscriptionID} Delete Subscription #
GET /v1/projects/{projectID}/subscriptions/{subscriptionID} Retrieve a Subscription #
PUT /v1/projects/{projectID}/subscriptions/{subscriptionID} Update a Subscription #

Documentation

📖
APIReference
https://getconvoy.io/docs/api-reference/welcome
📖
Documentation
https://getconvoy.io/docs/
📖
Authentication
https://getconvoy.io/docs/api-reference/authentication
📖
GettingStarted
https://getconvoy.io/docs/quickstart

Specifications

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

SDKs

📦
GitHubRepository
https://github.com/frain-dev/convoy

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-endpoint-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-event-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-event-delivery-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-delivery-attempt-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-subscription-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-source-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-portal-link-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-event-type-schema.json

Other Resources

🔗
Regions
https://getconvoy.io/docs
🔗
TermsOfService
https://getconvoy.io/terms
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-ld/convoy-context.jsonld
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./rules/convoy-rules.yml
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./vocabulary/convoy-vocabulary.yml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./examples/

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/convoy-subscriptions-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

convoy-subscriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@getconvoy.io
    name: Convoy Support
    url: https://getconvoy.io/docs
  description: Convoy is a fast and secure webhooks proxy. This document contains datastore's API specification.
  license:
    name: Mozilla Public License 2.0
    url: https://www.mozilla.org/en-US/MPL/2.0/
  termsOfService: https://getconvoy.io/terms
  title: Convoy API Reference Delivery Attempts Subscriptions API
  version: 26.3.5
servers:
- url: https://us.getconvoy.cloud/api
  description: US Region
- url: https://eu.getconvoy.cloud/api
  description: EU Region
tags:
- description: Subscription related APIs
  name: Subscriptions
paths:
  /v1/projects/{projectID}/sources/test_function:
    post:
      parameters:
      - description: Project ID
        in: path
        name: projectID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/models.FunctionResponse'
                  type: object
          description: OK
        '400':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Not Found
      security:
      - ApiKeyAuth: []
      tags:
      - Subscriptions
      description: This endpoint validates that a filter will match a certain payload structure.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/models.FunctionRequest'
        description: Function Details
        required: true
      summary: Validate Source Function
  /v1/projects/{projectID}/subscriptions:
    get:
      parameters:
      - description: Project ID
        in: path
        name: projectID
        required: true
        schema:
          type: string
      - in: query
        name: direction
        schema:
          enum:
          - next
          - prev
          type: string
        x-enum-varnames:
        - Next
        - Prev
      - description: A list of endpointIDs to filter by
        in: query
        name: endpointId
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Subscription name to filter by
        in: query
        name: name
        schema:
          type: string
      - description: A pagination cursor to fetch the next page of a list
        example: 01H0JA5MEES38RRK3HTEJC647K
        in: query
        name: next_page_cursor
        schema:
          type: string
      - description: The number of items to return per page
        example: 20
        in: query
        name: perPage
        schema:
          type: integer
      - description: A pagination cursor to fetch the previous page of a list
        example: 01H0JATTVCXZK8FRDX1M1JN3QY
        in: query
        name: prev_page_cursor
        schema:
          type: string
      - description: Sort order, values are `ASC` or `DESC`, defaults to `DESC`
        example: ASC | DESC
        in: query
        name: sort
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      allOf:
                      - $ref: '#/components/schemas/models.PagedResponse'
                      - properties:
                          content:
                            items:
                              $ref: '#/components/schemas/models.SubscriptionResponse'
                            type: array
                        type: object
                  type: object
          description: OK
        '400':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Not Found
      security:
      - ApiKeyAuth: []
      tags:
      - Subscriptions
      description: This endpoint fetches all the subscriptions
      operationId: GetSubscriptions
      summary: List All Subscriptions
    post:
      parameters:
      - description: Project ID
        in: path
        name: projectID
        required: true
        schema:
          type: string
      responses:
        '201':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/models.SubscriptionResponse'
                  type: object
          description: Created
        '400':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Not Found
      security:
      - ApiKeyAuth: []
      tags:
      - Subscriptions
      description: This endpoint creates a subscriptions
      operationId: CreateSubscription
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/models.CreateSubscription'
        description: Subscription details
        required: true
      summary: Create a Subscription
  /v1/projects/{projectID}/subscriptions/test_filter:
    post:
      parameters:
      - description: Project ID
        in: path
        name: projectID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      type: boolean
                  type: object
          description: OK
        '400':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Not Found
      security:
      - ApiKeyAuth: []
      tags:
      - Subscriptions
      description: This endpoint validates that a filter will match a certain payload structure.
      operationId: TestSubscriptionFilter
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/models.TestFilter'
        description: Filter Details
        required: true
      summary: Validate Subscription Filter
  /v1/projects/{projectID}/subscriptions/test_function:
    post:
      parameters:
      - description: Project ID
        in: path
        name: projectID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/models.FunctionResponse'
                  type: object
          description: OK
        '400':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Not Found
      security:
      - ApiKeyAuth: []
      tags:
      - Subscriptions
      description: This endpoint test runs a transform function against a payload.
      operationId: TestSubscriptionFunction
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/models.FunctionRequest'
        description: Function Details
        required: true
      summary: Test a Subscription Function
  /v1/projects/{projectID}/subscriptions/{subscriptionID}:
    delete:
      parameters:
      - description: Project ID
        in: path
        name: projectID
        required: true
        schema:
          type: string
      - description: subscription id
        in: path
        name: subscriptionID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: OK
        '400':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Not Found
      security:
      - ApiKeyAuth: []
      tags:
      - Subscriptions
      description: This endpoint deletes a subscription
      operationId: DeleteSubscription
      summary: Delete Subscription
    get:
      parameters:
      - description: Project ID
        in: path
        name: projectID
        required: true
        schema:
          type: string
      - description: subscription id
        in: path
        name: subscriptionID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/models.SubscriptionResponse'
                  type: object
          description: OK
        '400':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Not Found
      security:
      - ApiKeyAuth: []
      tags:
      - Subscriptions
      description: This endpoint retrieves a single subscription
      operationId: GetSubscription
      summary: Retrieve a Subscription
    put:
      parameters:
      - description: Project ID
        in: path
        name: projectID
        required: true
        schema:
          type: string
      - description: subscription id
        in: path
        name: subscriptionID
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/models.SubscriptionResponse'
                  type: object
          description: Accepted
        '400':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/handlers.Stub'
                  type: object
          description: Not Found
      security:
      - ApiKeyAuth: []
      tags:
      - Subscriptions
      description: This endpoint updates a subscription
      operationId: UpdateSubscription
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/models.UpdateSubscription'
        description: Subscription Details
        required: true
      summary: Update a Subscription
components:
  schemas:
    datastore.KafkaPubSubConfig:
      properties:
        auth:
          $ref: '#/components/schemas/datastore.KafkaAuth'
        brokers:
          items:
            type: string
          type: array
        consumer_group_id:
          type: string
        topic_name:
          type: string
      type: object
    datastore.SourceProvider:
      enum:
      - github
      - twitter
      - shopify
      type: string
      x-enum-varnames:
      - GithubSourceProvider
      - TwitterSourceProvider
      - ShopifySourceProvider
    datastore.Source:
      properties:
        body_function:
          type: string
        created_at:
          type: string
        custom_response:
          $ref: '#/components/schemas/datastore.CustomResponse'
        deleted_at:
          type: string
        forward_headers:
          items:
            type: string
          type: array
        header_function:
          type: string
        idempotency_keys:
          items:
            type: string
          type: array
        is_disabled:
          type: boolean
        mask_id:
          type: string
        name:
          type: string
        project_id:
          type: string
        provider:
          $ref: '#/components/schemas/datastore.SourceProvider'
        provider_config:
          $ref: '#/components/schemas/datastore.ProviderConfig'
        pub_sub:
          $ref: '#/components/schemas/datastore.PubSubConfig'
        type:
          $ref: '#/components/schemas/datastore.SourceType'
        uid:
          type: string
        updated_at:
          type: string
        url:
          type: string
        verifier:
          $ref: '#/components/schemas/datastore.VerifierConfig'
      type: object
    datastore.EndpointAuthenticationType:
      enum:
      - api_key
      - oauth2
      - basic_auth
      type: string
      x-enum-varnames:
      - APIKeyAuthentication
      - OAuth2Authentication
      - BasicAuthentication
    models.PagedResponse:
      properties:
        content: {}
        pagination:
          allOf:
          - $ref: '#/components/schemas/datastore.PaginationData'
      type: object
    datastore.CustomResponse:
      properties:
        body:
          type: string
        content_type:
          type: string
      type: object
    datastore.FilterSchema:
      properties:
        body:
          $ref: '#/components/schemas/datastore.M'
        headers:
          $ref: '#/components/schemas/datastore.M'
        is_flattened:
          type: boolean
      type: object
    datastore.PaginationData:
      properties:
        has_next_page:
          type: boolean
        has_prev_page:
          type: boolean
        next_page_cursor:
          type: string
        per_page:
          type: integer
        prev_page_cursor:
          type: string
      type: object
    datastore.BasicAuth:
      properties:
        password:
          type: string
        username:
          type: string
      type: object
    models.SubscriptionResponse:
      properties:
        alert_config:
          allOf:
          - $ref: '#/components/schemas/datastore.AlertConfiguration'
          description: subscription config
        created_at:
          type: string
        deleted_at:
          type: string
        delivery_mode:
          $ref: '#/components/schemas/datastore.DeliveryMode'
        device_metadata:
          $ref: '#/components/schemas/datastore.Device'
        endpoint_metadata:
          $ref: '#/components/schemas/datastore.Endpoint'
        filter_config:
          $ref: '#/components/schemas/datastore.FilterConfiguration'
        function:
          type: string
        name:
          type: string
        project_id:
          type: string
        rate_limit_config:
          $ref: '#/components/schemas/datastore.RateLimitConfiguration'
        retry_config:
          $ref: '#/components/schemas/datastore.RetryConfiguration'
        source_metadata:
          $ref: '#/components/schemas/datastore.Source'
        type:
          $ref: '#/components/schemas/datastore.SubscriptionType'
        uid:
          type: string
        updated_at:
          type: string
      type: object
    datastore.GooglePubSubConfig:
      properties:
        project_id:
          type: string
        service_account:
          items:
            type: integer
          type: array
        subscription_id:
          type: string
      type: object
    datastore.EndpointAuthentication:
      properties:
        api_key:
          $ref: '#/components/schemas/datastore.ApiKey'
        basic_auth:
          $ref: '#/components/schemas/datastore.BasicAuth'
        oauth2:
          $ref: '#/components/schemas/datastore.OAuth2'
        type:
          $ref: '#/components/schemas/datastore.EndpointAuthenticationType'
      type: object
    datastore.SubscriptionType:
      enum:
      - cli
      - api
      type: string
      x-enum-varnames:
      - SubscriptionTypeCLI
      - SubscriptionTypeAPI
    datastore.StrategyProvider:
      enum:
      - linear
      - exponential
      type: string
      x-enum-varnames:
      - LinearStrategyProvider
      - ExponentialStrategyProvider
    datastore.SourceType:
      enum:
      - http
      - rest_api
      - pub_sub
      - db_change_stream
      type: string
      x-enum-varnames:
      - HTTPSource
      - RestApiSource
      - PubSubSource
      - DBChangeStream
    datastore.DeliveryMode:
      enum:
      - at_least_once
      - at_most_once
      type: string
      x-enum-varnames:
      - AtLeastOnceDeliveryMode
      - AtMostOnceDeliveryMode
    handlers.Stub:
      type: object
    models.CreateSubscription:
      properties:
        alert_config:
          allOf:
          - $ref: '#/components/schemas/models.AlertConfiguration'
          description: Alert configuration
        app_id:
          description: Deprecated but necessary for backward compatibility
          type: string
        delivery_mode:
          allOf:
          - $ref: '#/components/schemas/datastore.DeliveryMode'
          description: Delivery mode configuration
        endpoint_id:
          description: Destination endpoint ID
          type: string
        filter_config:
          allOf:
          - $ref: '#/components/schemas/models.FilterConfiguration'
          description: Filter configuration
        function:
          description: 'Convoy supports mutating your request payload using a js function. Use this field

            to specify a `transform` function for this purpose. See this[https://docs.getconvoy.io/product-manual/subscriptions#functions] for more'
          type: string
        name:
          description: Subscription Nme
          type: string
        rate_limit_config:
          allOf:
          - $ref: '#/components/schemas/models.RateLimitConfiguration'
          description: Rate limit configuration
        source_id:
          description: Source Id
          type: string
      type: object
    datastore.EndpointStatus:
      enum:
      - active
      - inactive
      - paused
      type: string
      x-enum-varnames:
      - ActiveEndpointStatus
      - InactiveEndpointStatus
      - PausedEndpointStatus
    datastore.ApiKey:
      properties:
        header_name:
          type: string
        header_value:
          type: string
      type: object
    models.FilterConfiguration:
      properties:
        event_types:
          description: List of event types that the subscription should match
          items:
            type: string
          type: array
        filter:
          allOf:
          - $ref: '#/components/schemas/models.FS'
          description: Body & Header filters
      type: object
    models.UpdateSubscription:
      properties:
        alert_config:
          allOf:
          - $ref: '#/components/schemas/models.AlertConfiguration'
          description: Alert configuration
        app_id:
          description: Deprecated but necessary for backward compatibility
          type: string
        delivery_mode:
          allOf:
          - $ref: '#/components/schemas/datastore.DeliveryMode'
          description: Delivery mode configuration
        endpoint_id:
          description: Destination endpoint ID
          type: string
        filter_config:
          allOf:
          - $ref: '#/components/schemas/models.FilterConfiguration'
          description: Filter configuration
        function:
          description: 'Convoy supports mutating your request payload using a js function. Use this field

            to specify a `transform` function for this purpose. See this[https://docs.getconvoy.io/product-manual/subscriptions#functions] for more'
          type: string
        name:
          description: Subscription Nme
          type: string
        rate_limit_config:
          allOf:
          - $ref: '#/components/schemas/models.RateLimitConfiguration'
          description: Rate limit configuration
        retry_config:
          allOf:
          - $ref: '#/components/schemas/models.RetryConfiguration'
          description: Retry configuration
        source_id:
          description: Source Id
          type: string
      type: object
    models.RateLimitConfiguration:
      properties:
        count:
          type: integer
        duration:
          type: integer
      type: object
    datastore.SQSPubSubConfig:
      properties:
        access_key_id:
          type: string
        default_region:
          type: string
        endpoint:
          description: 'Optional: for LocalStack testing'
          type: string
        queue_name:
          type: string
        secret_key:
          type: string
      type: object
    models.FilterSchema:
      properties:
        body: {}
        header: {}
      type: object
    datastore.TwitterProviderConfig:
      properties:
        crc_verified_at:
          type: string
      type: object
    datastore.FilterConfiguration:
      properties:
        event_types:
          items:
            type: string
          type: array
        filter:
          $ref: '#/components/schemas/datastore.FilterSchema'
      type: object
    models.FunctionRequest:
      properties:
        function:
          type: string
        payload:
          additionalProperties: {}
          type: object
        type:
          type: string
      type: object
    datastore.AlertConfiguration:
      properties:
        count:
          type: integer
        threshold:
          type: string
      type: object
    datastore.PubSubConfig:
      properties:
        amqp:
          $ref: '#/components/schemas/datastore.AmqpPubSubConfig'
        google:
          $ref: '#/components/schemas/datastore.GooglePubSubConfig'
        kafka:
          $ref: '#/components/schemas/datastore.KafkaPubSubConfig'
        sqs:
          $ref: '#/components/schemas/datastore.SQSPubSubConfig'
        type:
          $ref: '#/components/schemas/datastore.PubSubType'
        workers:
          type: integer
      type: object
    datastore.M:
      additionalProperties: true
      type: object
    datastore.Device:
      properties:
        created_at:
          type: string
        deleted_at:
          type: string
        endpoint_id:
          type: string
        host_name:
          type: string
        last_seen_at:
          type: string
        project_id:
          type: string
        status:
          $ref: '#/components/schemas/datastore.DeviceStatus'
        uid:
          type: string
        updated_at:
          type: string
      type: object
    util.ServerResponse:
      properties:
        message:
          type: string
        status:
          type: boolean
      type: object
    models.TestFilter:
      properties:
        request:
          allOf:
          - $ref: '#/components/schemas/models.FilterSchema'
          description: Same Request & Headers
        schema:
          allOf:
          - $ref: '#/components/schemas/models.FilterSchema'
          description: Sample test schema
      type: object
    models.RetryConfiguration:
      properties:
        duration:
          description: Used to specify a valid Go time duration e.g 10s, 1h3m for how long to wait between event delivery retries
          type: string
        interval_seconds:
          description: Used to specify a time in seconds for how long to wait between event delivery retries,
          type: integer
        retry_count:
          description: Used to specify the max number of retries
          type: integer
        type:
          allOf:
          - $ref: '#/components/schemas/datastore.StrategyProvider'
          description: Retry Strategy type
      type: object
    datastore.OAuth2:
      properties:
        audience:
          type: string
        authentication_type:
          $ref: '#/components/schemas/datastore.OAuth2AuthenticationType'
        client_id:
          type: string
        client_secret:
          description: Encrypted at rest
          type: string
        expiry_time_unit:
          allOf:
          - $ref: '#/components/schemas/datastore.OAuth2ExpiryTimeUnit'
          description: Expiry time unit (seconds, milliseconds, minutes, hours)
        field_mapping:
          allOf:
          - $ref: '#/components/schemas/datastore.OAuth2FieldMapping'
          description: Field mapping for flexible token response parsing
        grant_type:
          type: string
        issuer:
          type: string
        scope:
          type: string
        signing_algorithm:
          type: string
        signing_key:
          allOf:
          - $ref: '#/components/schemas/datastore.OAuth2SigningKey'
          description: Encrypted at rest
        subject:
          type: string
        url:
          type: string
      type: object
    datastore.PubSubType:
      enum:
      - sqs
      - google
      - kafka
      - amqp
      type: string
      x-enum-varnames:
      - SqsPubSub
      - G

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/openapi/convoy-subscriptions-api-openapi.yml