- 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 source
This endpoint updates a source
Project ID
source id
Custom response is used to define a custom response for incoming webhooks project sources only.
Soecfy header you want convoy to save from the ingest request and forward to your endpoints when the event is dispatched.
IdempotencyKeys are used to specify parts of a webhook request to uniquely identify the event in an incoming webhooks project.
This is used to manually enable/disable the source.
Source name.
PubSub are used to specify message broker sources for outgoing
webhooks projects, you only need to speicfy this when the source type is pub_sub
.
Source Type.
Verifiers are used to verify webhook events ingested in incoming webhooks projects.
curl --request PUT \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/sources/{sourceID} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"custom_response": {
"body": "<string>",
"content_type": "<string>"
},
"forward_headers": [
"<string>"
],
"idempotency_keys": [
"<string>"
],
"is_disabled": true,
"name": "<string>",
"pub_sub": {
"amqp": {
"auth": {
"password": "<string>",
"user": "<string>"
},
"bindExchange": {
"exchange": "<string>",
"routingKey": "<string>"
},
"deadLetterExchange": "<string>",
"host": "<string>",
"port": "<string>",
"queue": "<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",
"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"
}
}'
{
"message": "<string>",
"status": true,
"data": {
"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"
}
}
}
Authorizations
Path Parameters
Project ID
source id
Body
Custom response is used to define a custom response for incoming webhooks project sources only.
Soecfy header you want convoy to save from the ingest request and forward to your endpoints when the event is dispatched.
IdempotencyKeys are used to specify parts of a webhook request to uniquely identify the event in an incoming webhooks project.
This is used to manually enable/disable the source.
Source name.
PubSub are used to specify message broker sources for outgoing
webhooks projects, you only need to speicfy this when the source type is pub_sub
.
sqs
, google
, kafka
, amqp
Source Type.
http
, rest_api
, pub_sub
, db_change_stream
Verifiers are used to verify webhook events ingested in incoming webhooks projects.
base64
, hex
noop
, hmac
, basic_auth
, api_key
Response
github
, twitter
, shopify
sqs
, google
, kafka
, amqp
http
, rest_api
, pub_sub
, db_change_stream
base64
, hex
noop
, hmac
, basic_auth
, api_key
Was this page helpful?
curl --request PUT \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/sources/{sourceID} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"custom_response": {
"body": "<string>",
"content_type": "<string>"
},
"forward_headers": [
"<string>"
],
"idempotency_keys": [
"<string>"
],
"is_disabled": true,
"name": "<string>",
"pub_sub": {
"amqp": {
"auth": {
"password": "<string>",
"user": "<string>"
},
"bindExchange": {
"exchange": "<string>",
"routingKey": "<string>"
},
"deadLetterExchange": "<string>",
"host": "<string>",
"port": "<string>",
"queue": "<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",
"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"
}
}'
{
"message": "<string>",
"status": true,
"data": {
"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"
}
}
}