PUT
/
v1
/
projects
/
{projectID}
/
sources
/
{sourceID}

Authorizations

Authorization
string
headerrequired

Path Parameters

projectID
string
required

Project ID

sourceID
string
required

source id

Body

application/json
body_function
string

Function is a javascript function used to mutate the payload immediately after ingesting an event

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.

header_function
string

Function is a javascript function used to mutate the headers immediately after ingesting an event

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 specify 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. If set, type is required and match the verifier type object you choose.

Response

202 - application/json
message
string
status
boolean
data
object

Was this page helpful?

Retrieve a sourceDelete a source