GEgetconvoy
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
    HTTP bearer

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

  • v3bae289777c91Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from object to no type for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      added the new enum value to the // response property for the response status

    • warning

      added the new enum value to the // response property for the response status

    • info

      added the new enum value to the request property ////

    • info

      added the new enum value to the request property /////

    • info

      added the new enum value to the request property ////

    • info

      added the new enum value to the request property //////

    • info

      added the new enum value to the request property /////

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

  • v3e171f744d209Revision changes
    • breaking

      the ////// request property type changed from array to string, and format from no format to byte

    • breaking

      the //// response's property type changed from array to string, and format from no format to byte for status