v51

latestSwagger 2.0Mozilla Public License 2.0raw.githubusercontent.com2026-08-0167151358.9 KB
Sources

Update a source

This endpoint updates a source

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

Path parameters

projectIDstring required

Project ID

sourceIDstring required

source id

Request body

body_functionstring

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

event_type_locationstring

EventTypeLocation is used to specify where Convoy should read the event type from an incoming webhook request.

forward_headersstring[]

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

header_functionstring

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

idempotency_keysstring[]

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

is_disabledboolean

This is used to manually enable/disable the source.

namestring

Source name.

type'http' | 'rest_api' | 'pub_sub' | 'db_change_stream' | ''

Response

Accepted

messagestring
statusboolean