Update a source

PUT

projects

{projectID}

sources

{sourceID}

object

custom_response

object

body

string

content_type

string

forward_headers

array

idempotency_keys

array

is_disabled

boolean

name

string

pub_sub

object

amqp

object

auth

object

password

string

user

string

bindExchange

object

exchange

string

routingKey

string

deadLetterExchange

string

host

string

port

string

queue

string

schema

string

google

object

project_id

string

service_account

array

subscription_id

string

kafka

object

auth

object

hash

string

password

string

tls

boolean

type

string

username

string

brokers

array

consumer_group_id

string

topic_name

string

sqs

object

access_key_id

string

default_region

string

queue_name

string

secret_key

string

type

enum<string>

workers

integer

type

enum<string>

verifier

object

api_key

object

header_name

string

header_value

string

basic_auth

object

password

string

username

string

hmac

object

encoding

enum<string>

hash

string

header

string

secret

string

type

enum<string>

Authorizations

Authorization

string

headerrequired

Path Parameters

projectID

string

required

Project ID

sourceID

string

required

source id

Body

application/json

custom_response

object

Custom response is used to define a custom response for incoming webhooks project sources only.

forward_headers

string[]

Soecfy header you want convoy to save from the ingest request and forward to your endpoints when the event is dispatched.

idempotency_keys

string[]

IdempotencyKeys are used to specify parts of a webhook request to uniquely identify the event in an incoming webhooks project.

is_disabled

boolean

This is used to manually enable/disable the source.

name

string

Source name.

pub_sub

object

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.

type

enum<string>

Source Type.

Available options:

http,

rest_api,

pub_sub,

db_change_stream

verifier

object

Verifiers are used to verify webhook events ingested in incoming webhooks projects.

Response

200 - application/json

message

string

status

boolean

data

object

data.created_at

string

data.custom_response

object

data.deleted_at

string

data.forward_headers

string[]

data.idempotency_keys

string[]

data.is_disabled

boolean

data.mask_id

string

data.name

string

data.project_id

string

data.provider

enum<string>

Available options:

github,

twitter,

shopify

data.provider_config

object

data.pub_sub

object

data.type

enum<string>

Available options:

http,

rest_api,

pub_sub,

db_change_stream

data.uid

string

data.updated_at

string

data.url

string

data.verifier

object

Was this page helpful?

Retrieve a source Delete a source

Introduction

Endpoints

Event Deliveries

Delivery Attempts

Events

Meta Events

Portal Links

Sources

Subscriptions

Update a source

Authorizations

Path Parameters

Body

Response