FRfrain-dev
Sources

Create a source

Changed on

This endpoint creates a source

post/v1/projects/{projectID}/sources

Request

  • Base URL
    https://us.getconvoy.cloud/api
  • Auth
    API key in header Authorization

Path parameters

projectIDstring required

Project 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.

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.

namestring

Source name.

provider'github' | 'twitter' | 'shopify' | ''
type'http' | 'rest_api' | 'pub_sub' | 'db_change_stream' | ''

Response

Created

messagestring
statusboolean

Changes