Convoy

Convoy is an open-source, cloud-native webhooks gateway used to securely ingest, persist, debug, deliver, and manage events. It positions itself as "the complete solution for secure, scalable, and reliable webhook delivery," covering both outbound (sending) and inbound (receiving) webhooks with retries, payload signing, fan-out, rate limiting, message broker ingestion, and customer-facing portals. Convoy is offered as a self-hosted open-source project (Elastic License v2.0, with the OpenAPI spec under MPL 2.0) and a fully managed cloud service in US and EU regions.

1 APIs 5 Features

WebhooksWebhook GatewayEvent DeliveryEventingMessagingIntegrationAPI Infrastructure

APIs

Convoy API

The Convoy REST API, version 26.3.5, exposes 44 operations across 11 resource groups for managing webhook delivery infrastructure: Subscriptions, Endpoints, Events, Sources, Eve...

Collections

Convoy API Reference

POSTMAN

Convoy API Reference

OPEN

Arazzo Workflows

Convoy Attach Filter to Subscription

Create a subscription, attach a body-matching filter, and confirm the filter list.

ARAZZO

Convoy Batch Retry Failed Deliveries

Detect failed deliveries for an endpoint and batch retry them in one call.

ARAZZO

Convoy Broadcast Event and Track

Broadcast an event to all matching subscriptions and trace the resulting event.

ARAZZO

Convoy Create Event and Trace Delivery

Publish an event to an endpoint, find its delivery, and read the delivery attempts.

ARAZZO

Convoy Define Event Type and Subscribe

Define a project event type, create an endpoint, and subscribe filtered to that type.

ARAZZO

Convoy Fan Out Event to Owner

Confirm endpoints exist for an owner, fan out an event to them, and verify it landed.

ARAZZO

Convoy Force Resend Successful Deliveries

Find a recent successful delivery for an endpoint and force resend it by ID.

ARAZZO

Convoy Inspect Delivery Attempts

Retrieve an event delivery, list its attempts, and drill into a single attempt.

ARAZZO

Convoy Provision Endpoint and Subscription

Stand up a webhook endpoint, subscribe it, send a first event, and confirm delivery.

ARAZZO

Convoy Register Incoming Source

Create an HMAC-verified incoming source and subscribe it to an endpoint.

ARAZZO

Convoy Replay Event

Pick a recent event, replay it as a fresh event, and trace the new deliveries.

ARAZZO

Convoy Retry a Failed Delivery

Find a failed event delivery, retry it, and inspect the resulting delivery attempts.

ARAZZO

Pricing Plans

Convoy Plans Pricing

3 plans

PLANS

Rate Limits

Convoy Rate Limits

0 limits

RATE LIMITS

FinOps

Convoy Finops

FINOPS

Features

GitHub

Shopify

Twitter/X

Mono

Generic HTTP (HMAC, Basic Auth, API Key, or Custom verification)

Use Cases

Webhook gateway between microservices and external consumers

Receiving webhooks from third-party providers and routing to internal services

Replacing in-house retry/signing/observability code for webhooks

Customer-facing webhook dashboards via embeddable portal links

Bridging message brokers to HTTP endpoints

Semantic Vocabularies

Convoy Context

48 classes · 10 properties

JSON-LD

API Governance Rules

Convoy API Rules

14 rules · 6 errors 5 warnings

SPECTRAL

JSON Structure

Convoy Delivery Attempt Structure

17 properties

JSON STRUCTURE

Convoy Endpoint Structure

22 properties

JSON STRUCTURE

Convoy Event Delivery Structure

25 properties

JSON STRUCTURE

Convoy Event Structure

20 properties

JSON STRUCTURE

Convoy Event Type Structure

6 properties

JSON STRUCTURE

Convoy Portal Link Structure

15 properties

JSON STRUCTURE

Convoy Source Structure

19 properties

JSON STRUCTURE

Convoy Subscription Structure

16 properties

JSON STRUCTURE

Example Payloads

Convoy Delivery Attempt Example

14 fields

EXAMPLE

Convoy Endpoint Example

15 fields

EXAMPLE

Convoy Event Delivery Example

9 fields

EXAMPLE

Convoy Event Example

8 fields

EXAMPLE

Convoy Event Type Example

8 fields

EXAMPLE

Convoy Op Activateendpoint Example

4 fields

EXAMPLE

Convoy Op Batchreplayevents Example

4 fields

EXAMPLE

Convoy Op Batchretryeventdelivery Example

4 fields

EXAMPLE

Convoy Op Bulkcreatefilters Example

4 fields

EXAMPLE

Convoy Op Bulkonboard Example

4 fields

EXAMPLE

Convoy Op Bulkupdatefilters Example

4 fields

EXAMPLE

Convoy Op Createbroadcastevent Example

4 fields

EXAMPLE

Convoy Op Createdynamicevent Example

4 fields

EXAMPLE

Convoy Op Createendpoint Example

4 fields

EXAMPLE

Convoy Op Createendpointevent Example

4 fields

EXAMPLE

Convoy Op Createendpointfanoutevent Example

4 fields

EXAMPLE

Convoy Op Createeventtype Example

4 fields

EXAMPLE

Convoy Op Createfilter Example

4 fields

EXAMPLE

Convoy Op Createportallink Example

4 fields

EXAMPLE

Convoy Op Createsource Example

4 fields

EXAMPLE

Convoy Op Createsubscription Example

4 fields

EXAMPLE

Convoy Op Deleteendpoint Example

4 fields

EXAMPLE

Convoy Op Deletefilter Example

4 fields

EXAMPLE

Convoy Op Deletesource Example

4 fields

EXAMPLE

Convoy Op Deletesubscription Example

4 fields

EXAMPLE

Convoy Op Deprecateeventtype Example

4 fields

EXAMPLE

Convoy Op Expiresecret Example

4 fields

EXAMPLE

Convoy Op Forceresendeventdeliveries Example

4 fields

EXAMPLE

Convoy Op Getdeliveryattempt Example

4 fields

EXAMPLE

Convoy Op Getdeliveryattempts Example

4 fields

EXAMPLE

Convoy Op Getendpoint Example

4 fields

EXAMPLE

Convoy Op Getendpointevent Example

4 fields

EXAMPLE

Convoy Op Getendpoints Example

4 fields

EXAMPLE

Convoy Op Geteventdeliveriespaged Example

4 fields

EXAMPLE

Convoy Op Geteventdelivery Example

4 fields

EXAMPLE

Convoy Op Geteventspaged Example

4 fields

EXAMPLE

Convoy Op Geteventtypes Example

4 fields

EXAMPLE

Convoy Op Getfilter Example

4 fields

EXAMPLE

Convoy Op Getfilters Example

4 fields

EXAMPLE

Convoy Op Getmetaevent Example

4 fields

EXAMPLE

Convoy Op Getmetaeventspaged Example

4 fields

EXAMPLE

Convoy Op Getportallink Example

4 fields

EXAMPLE

Convoy Op Getsource Example

4 fields

EXAMPLE

Convoy Op Getsubscription Example

4 fields

EXAMPLE

Convoy Op Getsubscriptions Example

4 fields

EXAMPLE

Convoy Op Importopenapispec Example

4 fields

EXAMPLE

Convoy Op Loadportallinkspaged Example

4 fields

EXAMPLE

Convoy Op Loadsourcespaged Example

4 fields

EXAMPLE

Convoy Op Pauseendpoint Example

4 fields

EXAMPLE

Convoy Op Post V1 Projects Projectid Sources Test Function Example

4 fields

EXAMPLE

Convoy Op Refreshportallinkauthtoken Example

4 fields

EXAMPLE

Convoy Op Replayendpointevent Example

4 fields

EXAMPLE

Convoy Op Resendeventdelivery Example

4 fields

EXAMPLE

Convoy Op Resendmetaevent Example

4 fields

EXAMPLE

Convoy Op Revokeportallink Example

4 fields

EXAMPLE

Convoy Op Testfilter Example

4 fields

EXAMPLE

Convoy Op Testoauth2Connection Example

4 fields

EXAMPLE

Convoy Op Testsubscriptionfilter Example

4 fields

EXAMPLE

Convoy Op Testsubscriptionfunction Example

4 fields

EXAMPLE

Convoy Op Updateendpoint Example

4 fields

EXAMPLE

Convoy Op Updateeventtype Example

4 fields

EXAMPLE

Convoy Op Updatefilter Example

4 fields

EXAMPLE

Convoy Op Updateportallink Example

4 fields

EXAMPLE

Convoy Op Updatesource Example

4 fields

EXAMPLE

Convoy Op Updatesubscription Example

4 fields

EXAMPLE

Convoy Portal Link Example

11 fields

EXAMPLE

Convoy Source Example

9 fields

EXAMPLE

Convoy Subscription Example

11 fields

EXAMPLE

Resources

PostmanWorkspace

PostmanWorkspace

DeveloperPortal

DeveloperPortal

Documentation

APIReference

GettingStarted

GitHubOrganization

GitHubOrganization

GitHubRepository

GitHubRepository

CodeExamples

CodeExamples

CodeExamples

Sources

opencollection: 1.0.0
info:
  name: Convoy API Reference
  version: 26.3.5
items:
- info:
    name: Endpoints
    type: folder
  items:
  - info:
      name: List All Endpoints
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: direction
        value: ''
        type: query
      - name: next_page_cursor
        value: 01H0JA5MEES38RRK3HTEJC647K
        type: query
        description: A pagination cursor to fetch the next page of a list
      - name: ownerId
        value: 01H0JA5MEES38RRK3HTEJC647K
        type: query
        description: The owner ID of the endpoint
      - name: perPage
        value: '20'
        type: query
        description: The number of items to return per page
      - name: prev_page_cursor
        value: 01H0JATTVCXZK8FRDX1M1JN3QY
        type: query
        description: A pagination cursor to fetch the previous page of a list
      - name: q
        value: endpoint-1
        type: query
        description: The name of the endpoint
      - name: sort
        value: ASC | DESC
        type: query
        description: Sort order, values are `ASC` or `DESC`, defaults to `DESC`
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint fetches an endpoints
  - info:
      name: Create an Endpoint
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint creates an endpoint
  - info:
      name: Test OAuth2 Connection
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints/oauth2/test
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint tests the OAuth2 connection by attempting to exchange a token
  - info:
      name: Retrieve Endpoint
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints/:endpointID
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: endpointID
        value: ''
        type: path
        description: Endpoint ID
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint fetches an endpoint
  - info:
      name: Update an Endpoint
      type: http
    http:
      method: PUT
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints/:endpointID
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: endpointID
        value: ''
        type: path
        description: Endpoint ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint updates an endpoint
  - info:
      name: Delete Endpoint
      type: http
    http:
      method: DELETE
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints/:endpointID
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: endpointID
        value: ''
        type: path
        description: Endpoint ID
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint deletes an endpoint
  - info:
      name: Activate Endpoint
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints/:endpointID/activate
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: endpointID
        value: ''
        type: path
        description: Endpoint ID
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Activated an inactive endpoint
  - info:
      name: Roll Endpoint Secret
      type: http
    http:
      method: PUT
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints/:endpointID/expire_secret
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: endpointID
        value: ''
        type: path
        description: Endpoint ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint expires and re-generates the endpoint secret.
  - info:
      name: Pause Endpoint
      type: http
    http:
      method: PUT
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints/:endpointID/pause
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: endpointID
        value: ''
        type: path
        description: Endpoint ID
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Toggles an endpoint's status between active and paused states
- info:
    name: EventTypes
    type: folder
  items:
  - info:
      name: Retrieves a Project's Event Types
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/event-types
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint fetches the project's event types
  - info:
      name: Create an Event Type
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/event-types
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint creates an event type
  - info:
      name: Import Event Types From OpenAPI Spec
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/event-types/import
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint imports event types from an OpenAPI specification
  - info:
      name: Updates an Event Type
      type: http
    http:
      method: PUT
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/event-types/:eventTypeId
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint updates an event type
  - info:
      name: Deprecates an Event Type
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/event-types/:eventTypeId/deprecate
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: eventTypeId
        value: ''
        type: path
        description: Event Type ID
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint deprecates an event type
- info:
    name: Event Deliveries
    type: folder
  items:
  - info:
      name: List All Event Deliveries
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/eventdeliveries
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: direction
        value: ''
        type: query
      - name: endDate
        value: '2008-05-02T15:04:05'
        type: query
        description: The end date
      - name: endpointId
        value: ''
        type: query
        description: A list of endpoint IDs to filter by
      - name: eventId
        value: ''
        type: query
        description: Event ID to filter by
      - name: event_type
        value: ''
        type: query
        description: EventType to filter by
      - name: idempotencyKey
        value: ''
        type: query
        description: IdempotencyKey to filter by
      - name: next_page_cursor
        value: 01H0JA5MEES38RRK3HTEJC647K
        type: query
        description: A pagination cursor to fetch the next page of a list
      - name: perPage
        value: '20'
        type: query
        description: The number of items to return per page
      - name: prev_page_cursor
        value: 01H0JATTVCXZK8FRDX1M1JN3QY
        type: query
        description: A pagination cursor to fetch the previous page of a list
      - name: sort
        value: ASC | DESC
        type: query
        description: Sort order, values are `ASC` or `DESC`, defaults to `DESC`
      - name: startDate
        value: '2006-01-02T15:04:05'
        type: query
        description: The start date
      - name: status
        value: ''
        type: query
        description: A list of event delivery statuses to filter by
      - name: subscriptionId
        value: ''
        type: query
        description: SubscriptionID to filter by
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint retrieves all event deliveries paginated.
  - info:
      name: Batch Retry Event Delivery
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/eventdeliveries/batchretry
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: direction
        value: ''
        type: query
      - name: endDate
        value: '2008-05-02T15:04:05'
        type: query
        description: The end date
      - name: endpointId
        value: ''
        type: query
        description: A list of endpoint IDs to filter by
      - name: eventId
        value: ''
        type: query
        description: Event ID to filter by
      - name: event_type
        value: ''
        type: query
        description: EventType to filter by
      - name: idempotencyKey
        value: ''
        type: query
        description: IdempotencyKey to filter by
      - name: next_page_cursor
        value: 01H0JA5MEES38RRK3HTEJC647K
        type: query
        description: A pagination cursor to fetch the next page of a list
      - name: perPage
        value: '20'
        type: query
        description: The number of items to return per page
      - name: prev_page_cursor
        value: 01H0JATTVCXZK8FRDX1M1JN3QY
        type: query
        description: A pagination cursor to fetch the previous page of a list
      - name: sort
        value: ASC | DESC
        type: query
        description: Sort order, values are `ASC` or `DESC`, defaults to `DESC`
      - name: startDate
        value: '2006-01-02T15:04:05'
        type: query
        description: The start date
      - name: status
        value: ''
        type: query
        description: A list of event delivery statuses to filter by
      - name: subscriptionId
        value: ''
        type: query
        description: SubscriptionID to filter by
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint batch retries multiple event deliveries at once.
  - info:
      name: Force Retry Event Delivery
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/eventdeliveries/forceresend
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint enables you retry a previously successful event delivery
  - info:
      name: Retrieve an Event Delivery
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/eventdeliveries/:eventDeliveryID
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: eventDeliveryID
        value: ''
        type: path
        description: event delivery id
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint fetches an event delivery.
  - info:
      name: Retry Event Delivery
      type: http
    http:
      method: PUT
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/eventdeliveries/:eventDeliveryID/resend
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: eventDeliveryID
        value: ''
        type: path
        description: event delivery id
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint retries an event delivery.
- info:
    name: Delivery Attempts
    type: folder
  items:
  - info:
      name: List Delivery Attempts
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/eventdeliveries/:eventDeliveryID/deliveryattempts
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: eventDeliveryID
        value: ''
        type: path
        description: event delivery id
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint fetches an app message's delivery attempts
  - info:
      name: Retrieve a Delivery Attempt
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/eventdeliveries/:eventDeliveryID/deliveryattempts/:deliveryAttemptID
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: eventDeliveryID
        value: ''
        type: path
        description: event delivery id
      - name: deliveryAttemptID
        value: ''
        type: path
        description: delivery attempt id
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint fetches an app event delivery attempt
- info:
    name: Events
    type: folder
  items:
  - info:
      name: List All Events
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/events
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: direction
        value: ''
        type: query
      - name: endDate
        value: '2008-05-02T15:04:05'
        type: query
        description: The end date
      - name: endpointId
        value: ''
        type: query
        description: A list of endpoint ids to filter by
      - name: idempotencyKey
        value: ''
        type: query
        description: IdempotencyKey to filter by
      - name: next_page_cursor
        value: 01H0JA5MEES38RRK3HTEJC647K
        type: query
        description: A pagination cursor to fetch the next page of a list
      - name: perPage
        value: '20'
        type: query
        description: The number of items to return per page
      - name: prev_page_cursor
        value: 01H0JATTVCXZK8FRDX1M1JN3QY
        type: query
        description: A pagination cursor to fetch the previous page of a list
      - name: query
        value: ''
        type: query
        description: Any arbitrary value to filter the events payload
      - name: sort
        value: ASC | DESC
        type: query
        description: Sort order, values are `ASC` or `DESC`, defaults to `DESC`
      - name: sourceId
        value: ''
        type: query
        description: A list of Source IDs to filter the events by.
      - name: startDate
        value: '2006-01-02T15:04:05'
        type: query
        description: The start date
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint fetches app events with pagination
  - info:
      name: Create an Event
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/events
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint creates an endpoint event
  - info:
      name: Batch Replay Events
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/events/batchreplay
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: direction
        value: ''
        type: query
      - name: endDate
        value: '2008-05-02T15:04:05'
        type: query
        description: The end date
      - name: endpointId
        value: ''
        type: query
        description: A list of endpoint ids to filter by
      - name: idempotencyKey
        value: ''
        type: query
        description: IdempotencyKey to filter by
      - name: next_page_cursor
        value: 01H0JA5MEES38RRK3HTEJC647K
        type: query
        description: A pagination cursor to fetch the next page of a list
      - name: perPage
        value: '20'
        type: query
        description: The number of items to return per page
      - name: prev_page_cursor
        value: 01H0JATTVCXZK8FRDX1M1JN3QY
        type: query
        description: A pagination cursor to fetch the previous page of a list
      - name: query
        value: ''
        type: query
        description: Any arbitrary value to filter the events payload
      - name: sort
        value: ASC | DESC
        type: query
        description: Sort order, values are `ASC` or `DESC`, defaults to `DESC`
      - name: sourceId
        value: ''
        type: query
        description: A list of Source IDs to filter the events by.
      - name: startDate
        value: '2006-01-02T15:04:05'
        type: query
        description: The start date
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint replays multiple events at once.
  - info:
      name: Create a Broadcast Event
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/events/broadcast
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type.
  - info:
      name: Dynamic Events
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/events/dynamic
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint does not require creating endpoint and subscriptions ahead of time. Instead, you supply the endpoint
      and the payload, and Convoy delivers the events
  - info:
      name: Fan Out an Event
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/events/fanout
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint uses the owner_id to fan out an event to multiple endpoints.
  - info:
      name: Retrieve an Event
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/events/:eventID
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: eventID
        value: ''
        type: path
        description: event id
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint retrieves an event
  - info:
      name: Replay Event
      type: http
    http:
      method: PUT
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/events/:eventID/replay
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: eventID
        value: ''
        type: path
        description: event id
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint replays an event afresh assuming it is a new event.
- info:
    name: Meta Events
    type: folder
  items:
  - info:
      name: List All Meta Events
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/meta-events
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: direction
        value: ''
        type: query
      - name: endDate
        value: '2008-05-02T15:04:05'
        type: query
        description: The end date
      - name: next_page_cursor
        value: 01H0JA5MEES38RRK3HTEJC647K
        type: query
        description: A pagination cursor to fetch the next page of a list
      - name: perPage
        value: '20'
        type: query
        description: The number of items to return per page
      - name: prev_page_cursor
        value: 01H0JATTVCXZK8FRDX1M1JN3QY
        type: query
        description: A pagination cursor to fetch the previous page of a list
      - name: sort
        value: ASC | DESC
        type: query
        description: Sort order, values are `ASC` or `DESC`, defaults to `DESC`
      - name: startDate
        value: '2006-01-02T15:04:05'
        type: query
        description: The start date
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint fetches meta events with pagination
  - info:
      name: Retrieve a Meta Event
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/meta-events/:metaEventID
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: metaEventID
        value: ''
        type: path
        description: meta event id
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint retrieves a meta event
  - info:
      name: Retry Meta Event
      type: http
    http:
      method: PUT
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/meta-events/:metaEventID/resend
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: metaEventID
        value: ''
        type: path
        description: meta event id
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint retries a meta event
- info:
    name: Onboard
    type: folder
  items:
  - info:
      name: Bulk Onboard Endpoints with Subscriptions
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/onboard
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: dry_run
        value: ''
        type: query
        description: Validate without creating
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint accepts a CSV file or JSON body to bulk-create endpoints with subscriptions
- info:
    name: Portal Links
    type: folder
  items:
  - info:
      name: List All Portal Links
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/portal-links
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: direction
        value: ''
        type: query
      - name: next_page_cursor
        value: 01H0JA5MEES38RRK3HTEJC647K
        type: query
        description: A pagination cursor to fetch the next page of a list
      - name: ownerId
        value: 01H0JA5MEES38RRK3HTEJC647K
        type: query
        description: The owner ID of the endpoint
      - name: perPage
        value: '20'
        type: query
        description: The number of items to return per page
      - name: prev_page_cursor
        value: 01H0JATTVCXZK8FRDX1M1JN3QY
        type: query
        description: A pagination cursor to fetch the previous page of a list
      - name: q
        value: endpoint-1
        type: query
        description: The name of the endpoint
      - name: sort
        value: ASC | DESC
        type: query
        description: Sort order, values are `ASC` or `DESC`, defaults to `DESC`
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint fetches multiple portal links
  - info:
      name: Create a Portal Link
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/portal-links
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint creates a portal link
  - info:
      name: Retrieve a Portal Link
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/portal-links/:portalLinkID
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: portalLinkID
        value: ''
        type: path
        description: portal link id
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint retrieves a portal link by its id.
  - info:
      name: Update a Portal Link
      type: http
    http:
      method: PUT
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/portal-links/:portalLinkID
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: portalLinkID
        value: ''
        type: path
        description: portal link id
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint updates a portal link
  - info:
      name: Get a Portal Link Auth Token
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/portal-links/:portalLinkID/refresh_token
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: portalLinkID
        value: ''
        type: path
        description: portal link id
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint retrieves a portal link auth token
  - info:
      name: Revoke a Portal Link
      type: http
    http:
      method: PUT
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/portal-links/:portalLinkID/revoke
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: portalLinkID
        value: ''
        type: path
        description: portal link id
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint revokes a portal link
- info:
    name: Sources
    type: folder
  items:
  - info:
      name: List All Sources
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/sources
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: direction
        value: ''
        type: query
      - name: next_page_cursor
        value: 01H0JA5MEES38RRK3HTEJC647K
        type: query
        description: A pagination cursor to fetch the next page of a list
      - name: perPage
        value: '20'
        type: query
        description: The number of items to return per page
      - name: prev_page_cursor
        value: 01H0JATTVCXZK8FRDX1M1JN3QY
        type: query
        description: A pagination cursor to fetch the previous page of a list
      - name: provider
        value: twitter
        type: query
        description: The custom source provider e.g. twitter, shopify
      - name: sort
        value: ASC | DESC
        type: query
        description: Sort order, values are `ASC` or `DESC`, defaults to `DESC`
      - name: type
        value: http
        type: query
        description: The source type e.g. http, pub_sub
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint fetches multiple sources
  - info:
      name: Create a Source
      type: http
    http:
      method: POST
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/sources
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint creates a source
  - info:
      name: Retrieve a Source
      type: http
    http:
      method: GET
      url: https://us.getconvoy.cloud/api/v1/projects/:projectID/sources/:sourceID
      params:
      - name: projectID
        value: ''
        type: path
        description: Project ID
      - name: sourceID
        value: ''
        type: path
        description: Source ID
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This endpoint retrieves a source by its id
  - info:
      name: Update a Source
      type: http
    http:
      method:

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