Convoy Delivery Attempts API

Delivery Attempt related APIs

Operations 2

GET /v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts List Delivery Attempts #
GET /v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts/{deliveryAttemptID} Retrieve a Delivery Attempt #

Documentation

Specifications

SDKs

Schemas & Data

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/
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/apis.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-attach-filter-to-subscription-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-batch-retry-failed-deliveries-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-broadcast-event-and-track-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-create-event-and-trace-delivery-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-define-event-type-and-subscribe-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-fanout-event-to-owner-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-force-resend-deliveries-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-inspect-delivery-attempts-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-provision-endpoint-subscription-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-register-incoming-source-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-replay-event-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-retry-failed-delivery-workflow.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/convoy-delivery-attempts-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

convoy-delivery-attempts-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 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: Delivery Attempt related APIs
  name: Delivery Attempts
paths:
  /v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts:
    get:
      parameters:
      - description: Project ID
        in: path
        name: projectID
        required: true
        schema:
          type: string
      - description: event delivery id
        in: path
        name: eventDeliveryID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      items:
                        $ref: '#/components/schemas/datastore.DeliveryAttempt'
                      type: array
                  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:
      - Delivery Attempts
      description: This endpoint fetches an app message's delivery attempts
      operationId: GetDeliveryAttempts
      summary: List Delivery Attempts
  /v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts/{deliveryAttemptID}:
    get:
      parameters:
      - description: Project ID
        in: path
        name: projectID
        required: true
        schema:
          type: string
      - description: event delivery id
        in: path
        name: eventDeliveryID
        required: true
        schema:
          type: string
      - description: delivery attempt id
        in: path
        name: deliveryAttemptID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/util.ServerResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/datastore.DeliveryAttempt'
                  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:
      - Delivery Attempts
      description: This endpoint fetches an app event delivery attempt
      operationId: GetDeliveryAttempt
      summary: Retrieve a Delivery Attempt
components:
  schemas:
    datastore.DeliveryAttempt:
      properties:
        api_version:
          type: string
        created_at:
          type: string
        deleted_at:
          type: string
        endpoint_id:
          type: string
        error:
          type: string
        http_status:
          type: string
        ip_address:
          type: string
        method:
          type: string
        msg_id:
          type: string
        project_id:
          type: string
        request_http_header:
          $ref: '#/components/schemas/datastore.HttpHeader'
        response_data:
          type: string
        response_http_header:
          $ref: '#/components/schemas/datastore.HttpHeader'
        status:
          type: boolean
        uid:
          type: string
        updated_at:
          type: string
        url:
          type: string
      type: object
    datastore.HttpHeader:
      additionalProperties:
        type: string
      type: object
    handlers.Stub:
      type: object
    util.ServerResponse:
      properties:
        message:
          type: string
        status:
          type: boolean
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: Authorization
      type: apiKey