GET
/
v1
/
projects
/
{projectID}
/
sources
curl --request GET \
  --url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/sources \
  --header 'Authorization: <api-key>'
{
  "message": "<string>",
  "status": true,
  "data": {
    "content": [
      {
        "body_function": "<string>",
        "created_at": "<string>",
        "custom_response": {
          "body": "<string>",
          "content_type": "<string>"
        },
        "deleted_at": "<string>",
        "forward_headers": [
          "<string>"
        ],
        "header_function": "<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>",
            "vhost": "<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"
        }
      }
    ],
    "pagination": {
      "has_next_page": true,
      "has_prev_page": true,
      "next_page_cursor": "<string>",
      "per_page": 123,
      "prev_page_cursor": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
projectID
string
required

Project ID

Query Parameters

​
direction
enum<string>
Available options:
next,
prev
​
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

​
provider
string

The custom source provider e.g. twitter, shopify

​
sort
string

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

​
type
string

The source type e.g. http, pub_sub

Response

200
application/json
OK
​
message
string
​
status
boolean
​
data
object

Was this page helpful?

Revoke a portal linkCreate a source