Subscriptions
Retrieve a subscription
- Community
- GitHub
- Tutorials
- GETList all endpoints
- POSTCreate an endpoint
- GETRetrieve endpoint
- PUTUpdate an endpoint
- DELDelete endpoint
- PUTRoll endpoint secret
- PUTPause endpoint
- GETList all event deliveries
- POSTBatch retry event delivery
- POSTForce retry event delivery
- GETRetrieve an event delivery
- PUTRetry event delivery
- GETList all events
- POSTCreate an event
- POSTCreate a broadcast event
- POSTBatch replay events
- POSTDynamic Events
- POSTFan out an event
- GETRetrieve an event
- PUTReplay event
- GETList all portal links
- POSTCreate a portal link
- GETRetrieve a portal link
- PUTUpdate a portal link
- PUTRevoke a portal link
Endpoints
Event Deliveries
Events
Portal Links
Subscriptions
Retrieve a subscription
This endpoint retrieves a single subscription
GET
/
v1
/
projects
/
{projectID}
/
subscriptions
/
{subscriptionID}
Authorization
string
*
Authorization
Required
string
projectID
string
*
projectID
Required
string
Project ID
subscriptionID
string
*
subscriptionID
Required
string
subscription id
curl --request GET \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/subscriptions/{subscriptionID} \
--header 'Authorization: <api-key>'
{
"message": "<string>",
"status": true,
"data": {
"alert_config": {
"count": 123,
"threshold": "<string>"
},
"created_at": "<string>",
"deleted_at": "<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_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>"
},
"filter_config": {
"event_types": [
"<string>"
],
"filter": {
"body": {},
"headers": {}
}
},
"function": {
"string": "<string>",
"valid": true
},
"name": "<string>",
"rate_limit_config": {
"count": 123,
"duration": 123
},
"retry_config": {
"duration": 123,
"retry_count": 123,
"type": "linear"
},
"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"
}
},
"type": "cli",
"uid": "<string>",
"updated_at": "<string>"
}
}
Authorizations
Authorization
string
headerrequiredPath Parameters
projectID
string
requiredProject ID
subscriptionID
string
requiredsubscription id
Response
200 - application/json
message
string
status
boolean
data
object
data.alert_config
object
subscription config
data.alert_config.count
integer
data.alert_config.threshold
string
data.created_at
string
data.deleted_at
string
data.device_metadata
object
data.device_metadata.created_at
string
data.device_metadata.deleted_at
string
data.device_metadata.endpoint_id
string
data.device_metadata.host_name
string
data.device_metadata.last_seen_at
string
data.device_metadata.project_id
string
data.device_metadata.status
enum<string>
Available options:
offline
, online
, disabled
data.device_metadata.uid
string
data.device_metadata.updated_at
string
data.endpoint_metadata
object
data.endpoint_metadata.advanced_signatures
boolean
data.endpoint_metadata.authentication
object
data.endpoint_metadata.authentication.api_key
object
data.endpoint_metadata.authentication.api_key.header_name
string
data.endpoint_metadata.authentication.api_key.header_value
string
data.endpoint_metadata.authentication.type
enum<string>
Available options:
api_key
data.endpoint_metadata.created_at
string
data.endpoint_metadata.deleted_at
string
data.endpoint_metadata.description
string
data.endpoint_metadata.events
integer
data.endpoint_metadata.http_timeout
integer
data.endpoint_metadata.name
string
data.endpoint_metadata.owner_id
string
data.endpoint_metadata.project_id
string
data.endpoint_metadata.rate_limit
integer
data.endpoint_metadata.rate_limit_duration
integer
data.endpoint_metadata.secrets
object[]
data.endpoint_metadata.secrets.created_at
string
data.endpoint_metadata.secrets.deleted_at
string
data.endpoint_metadata.secrets.expires_at
string
data.endpoint_metadata.secrets.uid
string
data.endpoint_metadata.secrets.updated_at
string
data.endpoint_metadata.secrets.value
string
data.endpoint_metadata.slack_webhook_url
string
data.endpoint_metadata.status
enum<string>
Available options:
active
, inactive
, pending
, paused
data.endpoint_metadata.support_email
string
data.endpoint_metadata.uid
string
data.endpoint_metadata.updated_at
string
data.endpoint_metadata.url
string
data.filter_config
object
data.filter_config.event_types
string[]
data.filter_config.filter
object
data.filter_config.filter.body
object
data.filter_config.filter.headers
object
data.function
object
data.function.string
string
data.function.valid
boolean
Valid is true if String is not NULL
data.name
string
data.rate_limit_config
object
data.rate_limit_config.count
integer
data.rate_limit_config.duration
integer
data.retry_config
object
data.retry_config.duration
integer
data.retry_config.retry_count
integer
data.retry_config.type
enum<string>
Available options:
linear
, exponential
data.source_metadata
object
data.source_metadata.created_at
string
data.source_metadata.custom_response
object
data.source_metadata.custom_response.body
string
data.source_metadata.custom_response.content_type
string
data.source_metadata.deleted_at
string
data.source_metadata.forward_headers
string[]
data.source_metadata.idempotency_keys
string[]
data.source_metadata.is_disabled
boolean
data.source_metadata.mask_id
string
data.source_metadata.name
string
data.source_metadata.project_id
string
data.source_metadata.provider
enum<string>
Available options:
github
, twitter
, shopify
data.source_metadata.provider_config
object
data.source_metadata.provider_config.twitter
object
data.source_metadata.provider_config.twitter.crc_verified_at
string
data.source_metadata.pub_sub
object
data.source_metadata.pub_sub.amqp
object
data.source_metadata.pub_sub.amqp.auth
object
data.source_metadata.pub_sub.amqp.auth.password
string
data.source_metadata.pub_sub.amqp.auth.user
string
data.source_metadata.pub_sub.amqp.bindedExchange
string
data.source_metadata.pub_sub.amqp.deadLetterExchange
string
data.source_metadata.pub_sub.amqp.host
string
data.source_metadata.pub_sub.amqp.port
string
data.source_metadata.pub_sub.amqp.queue
string
data.source_metadata.pub_sub.amqp.routingKey
string
data.source_metadata.pub_sub.amqp.schema
string
data.source_metadata.pub_sub.google
object
data.source_metadata.pub_sub.google.project_id
string
data.source_metadata.pub_sub.google.service_account
integer[]
data.source_metadata.pub_sub.google.subscription_id
string
data.source_metadata.pub_sub.kafka
object
data.source_metadata.pub_sub.kafka.auth
object
data.source_metadata.pub_sub.kafka.auth.hash
string
data.source_metadata.pub_sub.kafka.auth.password
string
data.source_metadata.pub_sub.kafka.auth.tls
boolean
data.source_metadata.pub_sub.kafka.auth.type
string
data.source_metadata.pub_sub.kafka.auth.username
string
data.source_metadata.pub_sub.kafka.brokers
string[]
data.source_metadata.pub_sub.kafka.consumer_group_id
string
data.source_metadata.pub_sub.kafka.topic_name
string
data.source_metadata.pub_sub.sqs
object
data.source_metadata.pub_sub.sqs.access_key_id
string
data.source_metadata.pub_sub.sqs.default_region
string
data.source_metadata.pub_sub.sqs.queue_name
string
data.source_metadata.pub_sub.sqs.secret_key
string
data.source_metadata.pub_sub.type
enum<string>
Available options:
sqs
, google
, kafka
, amqp
data.source_metadata.pub_sub.workers
integer
data.source_metadata.type
enum<string>
Available options:
http
, rest_api
, pub_sub
, db_change_stream
data.source_metadata.uid
string
data.source_metadata.updated_at
string
data.source_metadata.url
string
data.source_metadata.verifier
object
data.source_metadata.verifier.api_key
object
data.source_metadata.verifier.api_key.header_name
string
data.source_metadata.verifier.api_key.header_value
string
data.source_metadata.verifier.basic_auth
object
data.source_metadata.verifier.basic_auth.password
string
data.source_metadata.verifier.basic_auth.username
string
data.source_metadata.verifier.hmac
object
data.source_metadata.verifier.hmac.encoding
enum<string>
Available options:
base64
, hex
data.source_metadata.verifier.hmac.hash
string
data.source_metadata.verifier.hmac.header
string
data.source_metadata.verifier.hmac.secret
string
data.source_metadata.verifier.type
enum<string>
Available options:
noop
, hmac
, basic_auth
, api_key
data.type
enum<string>
Available options:
cli
, api
data.uid
string
data.updated_at
string
Was this page helpful?
curl --request GET \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/subscriptions/{subscriptionID} \
--header 'Authorization: <api-key>'
{
"message": "<string>",
"status": true,
"data": {
"alert_config": {
"count": 123,
"threshold": "<string>"
},
"created_at": "<string>",
"deleted_at": "<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_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>"
},
"filter_config": {
"event_types": [
"<string>"
],
"filter": {
"body": {},
"headers": {}
}
},
"function": {
"string": "<string>",
"valid": true
},
"name": "<string>",
"rate_limit_config": {
"count": 123,
"duration": 123
},
"retry_config": {
"duration": 123,
"retry_count": 123,
"type": "linear"
},
"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"
}
},
"type": "cli",
"uid": "<string>",
"updated_at": "<string>"
}
}