Start Your Project
Start Your Project

Subscriptions

Update a subscription

Documentation

API Reference

Community
GitHub
Tutorials

Subscriptions

Update a subscription

This endpoint updates a subscription

PUT

projects

{projectID}

subscriptions

{subscriptionID}

Authorization

string

Authorization

Required

string

projectID

string

projectID

Required

string

Project ID

subscriptionID

string

subscriptionID

Required

string

subscription id

object

alert_config

object

alert_config

object

Alert configuration

count

integer

count

integer

Count

threshold

string

threshold

string

Threshold

app_id

string

app_id

string

Deprecated but necessary for backward compatibility

endpoint_id

string

endpoint_id

string

Destination endpoint ID

filter_config

object

filter_config

object

Filter configuration

event_types

array

event_types

array

List of event types that the subscription should match

filter

object

filter

object

Body & Header filters

body

object

body

object

headers

object

headers

object

function

string

function

string

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

name

string

name

string

Subscription Nme

rate_limit_config

object

rate_limit_config

object

Rate limit configuration

count

integer

count

integer

duration

integer

duration

integer

retry_config

object

retry_config

object

Retry configuration

duration

string

duration

string

Used to specify a valid Go time duration e.g 10s, 1h3m for how long to wait between event delivery retries

interval_seconds

integer

interval_seconds

integer

Used to specify a time in seconds for how long to wait between event delivery retries,

retry_count

integer

retry_count

integer

Used to specify the max number of retries

type

enum<string>

type

enum<string>

Retry Strategy type

source_id

string

source_id

string

Source Id

Authorizations

Authorization

string

headerrequired

Path Parameters

projectID

string

required

Project ID

subscriptionID

string

required

subscription id

Body

application/json

alert_config

object

Alert configuration

alert_config.count

integer

Count

alert_config.threshold

string

Threshold

app_id

string

Deprecated but necessary for backward compatibility

endpoint_id

string

Destination endpoint ID

filter_config

object

Filter configuration

filter_config.event_types

string[]

List of event types that the subscription should match

filter_config.filter

object

Body & Header filters

filter_config.filter.body

object

filter_config.filter.headers

object

function

string

name

string

Subscription Nme

rate_limit_config

object

Rate limit configuration

rate_limit_config.count

integer

rate_limit_config.duration

integer

retry_config

object

Retry configuration

retry_config.duration

string

Used to specify a valid Go time duration e.g 10s, 1h3m for how long to wait between event delivery retries

retry_config.interval_seconds

integer

Used to specify a time in seconds for how long to wait between event delivery retries,

retry_config.retry_count

integer

Used to specify the max number of retries

retry_config.type

enum<string>

Retry Strategy type

Available options:

linear,

exponential

source_id

string

Source 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?

Retrieve a subscription Delete subscription

twitter linkedin

Introduction

Endpoints

Event Deliveries

Delivery Attempts

Events

Meta Events

Portal Links

Sources

Subscriptions

Authorizations

Path Parameters

Body

Response