- 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
Update a subscription
This endpoint updates a subscription
Project ID
subscription id
Alert configuration
Count
Threshold
Deprecated but necessary for backward compatibility
Destination endpoint ID
Filter configuration
List of event types that the subscription should match
Body & Header filters
Convoy supports mutating your request payload using a js function. Use this field
to specify a transform
function for this purpose. See this[https://docs.getconvoy.io/product-manual/subscriptions#functions] for more
Subscription Nme
Rate limit configuration
Retry configuration
Used to specify a valid Go time duration e.g 10s, 1h3m for how long to wait between event delivery retries
Used to specify a time in seconds for how long to wait between event delivery retries,
Used to specify the max number of retries
Retry Strategy type
Source Id
curl --request PUT \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/subscriptions/{subscriptionID} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"alert_config": {
"count": 123,
"threshold": "<string>"
},
"app_id": "<string>",
"endpoint_id": "<string>",
"filter_config": {
"event_types": [
"<string>"
],
"filter": {
"body": {},
"headers": {}
}
},
"function": "<string>",
"name": "<string>",
"rate_limit_config": {
"count": 123,
"duration": 123
},
"retry_config": {
"duration": "<string>",
"interval_seconds": 123,
"retry_count": 123,
"type": "linear"
},
"source_id": "<string>"
}'
{
"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
Path Parameters
Project ID
subscription id
Body
Alert configuration
Count
Threshold
Deprecated but necessary for backward compatibility
Destination endpoint ID
Filter configuration
List of event types that the subscription should match
Body & Header filters
Convoy supports mutating your request payload using a js function. Use this field
to specify a transform
function for this purpose. See this[https://docs.getconvoy.io/product-manual/subscriptions#functions] for more
Subscription Nme
Rate limit configuration
Retry configuration
Used to specify a valid Go time duration e.g 10s, 1h3m for how long to wait between event delivery retries
Used to specify a time in seconds for how long to wait between event delivery retries,
Used to specify the max number of retries
Retry Strategy type
linear
, exponential
Source Id
Response
subscription config
offline
, online
, disabled
api_key
active
, inactive
, pending
, paused
Valid is true if String is not NULL
linear
, exponential
github
, twitter
, shopify
sqs
, google
, kafka
, amqp
http
, rest_api
, pub_sub
, db_change_stream
base64
, hex
noop
, hmac
, basic_auth
, api_key
cli
, api
Was this page helpful?
curl --request PUT \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/subscriptions/{subscriptionID} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"alert_config": {
"count": 123,
"threshold": "<string>"
},
"app_id": "<string>",
"endpoint_id": "<string>",
"filter_config": {
"event_types": [
"<string>"
],
"filter": {
"body": {},
"headers": {}
}
},
"function": "<string>",
"name": "<string>",
"rate_limit_config": {
"count": 123,
"duration": 123
},
"retry_config": {
"duration": "<string>",
"interval_seconds": 123,
"retry_count": 123,
"type": "linear"
},
"source_id": "<string>"
}'
{
"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>"
}
}