GET
/
v1
/
projects
/
{projectID}
/
eventdeliveries
curl --request GET \
  --url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/eventdeliveries \
  --header 'Authorization: <api-key>'
{
  "message": "<string>",
  "status": true,
  "data": {
    "content": [
      {
        "cli_metadata": {
          "event_type": "<string>",
          "source_id": "<string>"
        },
        "created_at": "<string>",
        "deleted_at": "<string>",
        "description": "<string>",
        "device_id": "<string>",
        "device_metadata": {
          "created_at": "<string>",
          "deleted_at": "<string>",
          "endpoint_id": "<string>",
          "host_name": "<string>",
          "last_seen_at": "<string>",
          "project_id": "<string>",
          "status": "offline",
          "uid": "<string>",
          "updated_at": "<string>"
        },
        "endpoint_id": "<string>",
        "endpoint_metadata": {
          "advanced_signatures": true,
          "authentication": {
            "api_key": {
              "header_name": "<string>",
              "header_value": "<string>"
            },
            "type": "api_key"
          },
          "created_at": "<string>",
          "deleted_at": "<string>",
          "description": "<string>",
          "events": 123,
          "http_timeout": 123,
          "name": "<string>",
          "owner_id": "<string>",
          "project_id": "<string>",
          "rate_limit": 123,
          "rate_limit_duration": 123,
          "secrets": [
            {
              "created_at": "<string>",
              "deleted_at": "<string>",
              "expires_at": "<string>",
              "uid": "<string>",
              "updated_at": "<string>",
              "value": "<string>"
            }
          ],
          "slack_webhook_url": "<string>",
          "status": "active",
          "support_email": "<string>",
          "uid": "<string>",
          "updated_at": "<string>",
          "url": "<string>"
        },
        "event_id": "<string>",
        "event_metadata": {
          "app_id": "<string>",
          "created_at": "<string>",
          "data": [
            123
          ],
          "deleted_at": "<string>",
          "endpoint_metadata": [
            {
              "advanced_signatures": true,
              "authentication": {
                "api_key": {
                  "header_name": "<string>",
                  "header_value": "<string>"
                },
                "type": "api_key"
              },
              "created_at": "<string>",
              "deleted_at": "<string>",
              "description": "<string>",
              "events": 123,
              "http_timeout": 123,
              "name": "<string>",
              "owner_id": "<string>",
              "project_id": "<string>",
              "rate_limit": 123,
              "rate_limit_duration": 123,
              "secrets": [
                {
                  "created_at": "<string>",
                  "deleted_at": "<string>",
                  "expires_at": "<string>",
                  "uid": "<string>",
                  "updated_at": "<string>",
                  "value": "<string>"
                }
              ],
              "slack_webhook_url": "<string>",
              "status": "active",
              "support_email": "<string>",
              "uid": "<string>",
              "updated_at": "<string>",
              "url": "<string>"
            }
          ],
          "endpoints": [
            "<string>"
          ],
          "event_type": "<string>",
          "headers": {},
          "idempotency_key": "<string>",
          "is_duplicate_event": true,
          "project_id": "<string>",
          "raw": "<string>",
          "source_id": "<string>",
          "source_metadata": {
            "created_at": "<string>",
            "custom_response": {
              "body": "<string>",
              "content_type": "<string>"
            },
            "deleted_at": "<string>",
            "forward_headers": [
              "<string>"
            ],
            "idempotency_keys": [
              "<string>"
            ],
            "is_disabled": true,
            "mask_id": "<string>",
            "name": "<string>",
            "project_id": "<string>",
            "provider": "github",
            "provider_config": {
              "twitter": {
                "crc_verified_at": "<string>"
              }
            },
            "pub_sub": {
              "amqp": {
                "auth": {
                  "password": "<string>",
                  "user": "<string>"
                },
                "bindedExchange": "<string>",
                "deadLetterExchange": "<string>",
                "host": "<string>",
                "port": "<string>",
                "queue": "<string>",
                "routingKey": "<string>",
                "schema": "<string>"
              },
              "google": {
                "project_id": "<string>",
                "service_account": [
                  123
                ],
                "subscription_id": "<string>"
              },
              "kafka": {
                "auth": {
                  "hash": "<string>",
                  "password": "<string>",
                  "tls": true,
                  "type": "<string>",
                  "username": "<string>"
                },
                "brokers": [
                  "<string>"
                ],
                "consumer_group_id": "<string>",
                "topic_name": "<string>"
              },
              "sqs": {
                "access_key_id": "<string>",
                "default_region": "<string>",
                "queue_name": "<string>",
                "secret_key": "<string>"
              },
              "type": "sqs",
              "workers": 123
            },
            "type": "http",
            "uid": "<string>",
            "updated_at": "<string>",
            "url": "<string>",
            "verifier": {
              "api_key": {
                "header_name": "<string>",
                "header_value": "<string>"
              },
              "basic_auth": {
                "password": "<string>",
                "username": "<string>"
              },
              "hmac": {
                "encoding": "base64",
                "hash": "<string>",
                "header": "<string>",
                "secret": "<string>"
              },
              "type": "noop"
            }
          },
          "uid": "<string>",
          "updated_at": "<string>",
          "url_query_params": "<string>"
        },
        "event_type": "<string>",
        "headers": {},
        "idempotency_key": "<string>",
        "latency": "<string>",
        "metadata": {
          "data": [
            123
          ],
          "interval_seconds": 123,
          "next_send_time": "<string>",
          "num_trials": 123,
          "raw": "<string>",
          "retry_limit": 123,
          "strategy": "linear"
        },
        "project_id": "<string>",
        "source_metadata": {
          "created_at": "<string>",
          "custom_response": {
            "body": "<string>",
            "content_type": "<string>"
          },
          "deleted_at": "<string>",
          "forward_headers": [
            "<string>"
          ],
          "idempotency_keys": [
            "<string>"
          ],
          "is_disabled": true,
          "mask_id": "<string>",
          "name": "<string>",
          "project_id": "<string>",
          "provider": "github",
          "provider_config": {
            "twitter": {
              "crc_verified_at": "<string>"
            }
          },
          "pub_sub": {
            "amqp": {
              "auth": {
                "password": "<string>",
                "user": "<string>"
              },
              "bindedExchange": "<string>",
              "deadLetterExchange": "<string>",
              "host": "<string>",
              "port": "<string>",
              "queue": "<string>",
              "routingKey": "<string>",
              "schema": "<string>"
            },
            "google": {
              "project_id": "<string>",
              "service_account": [
                123
              ],
              "subscription_id": "<string>"
            },
            "kafka": {
              "auth": {
                "hash": "<string>",
                "password": "<string>",
                "tls": true,
                "type": "<string>",
                "username": "<string>"
              },
              "brokers": [
                "<string>"
              ],
              "consumer_group_id": "<string>",
              "topic_name": "<string>"
            },
            "sqs": {
              "access_key_id": "<string>",
              "default_region": "<string>",
              "queue_name": "<string>",
              "secret_key": "<string>"
            },
            "type": "sqs",
            "workers": 123
          },
          "type": "http",
          "uid": "<string>",
          "updated_at": "<string>",
          "url": "<string>",
          "verifier": {
            "api_key": {
              "header_name": "<string>",
              "header_value": "<string>"
            },
            "basic_auth": {
              "password": "<string>",
              "username": "<string>"
            },
            "hmac": {
              "encoding": "base64",
              "hash": "<string>",
              "header": "<string>",
              "secret": "<string>"
            },
            "type": "noop"
          }
        },
        "status": "Scheduled",
        "subscription_id": "<string>",
        "uid": "<string>",
        "updated_at": "<string>",
        "url_query_params": "<string>"
      }
    ],
    "pagination": {
      "has_next_page": true,
      "has_prev_page": true,
      "next_page_cursor": "<string>",
      "per_page": 123,
      "prev_page_cursor": "<string>"
    }
  }
}

Authorizations

Authorization
string
headerrequired

Path Parameters

projectID
string
required

Project ID

Query Parameters

direction
enum<string>
Available options:
next,
prev
endDate
string

The end date

endpointId
string[]

A list of endpoint IDs to filter by

eventId
string

Event ID to filter by

event_type
string

EventType to filter by

idempotencyKey
string

IdempotencyKey to filter by

next_page_cursor
string

A pagination cursor to fetch the next page of a list

perPage
integer

The number of items to return per page

prev_page_cursor
string

A pagination cursor to fetch the previous page of a list

sort
string

Sort order, values are ASC or DESC, defaults to DESC

startDate
string

The start date

status
string[]

A list of event delivery statuses to filter by

subscriptionId
string

SubscriptionID to filter by

Response

200 - application/json
message
string
status
boolean
data
object

Was this page helpful?

Pause endpointBatch retry event delivery