PUT
/
v1
/
projects
/
{projectID}
/
sources
/
{sourceID}
curl --request PUT \
  --url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/sources/{sourceID} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "body_function": "<string>",
  "custom_response": {
    "body": "<string>",
    "content_type": "<string>"
  },
  "forward_headers": [
    "<string>"
  ],
  "header_function": "<string>",
  "idempotency_keys": [
    "<string>"
  ],
  "is_disabled": true,
  "name": "<string>",
  "pub_sub": {
    "amqp": {
      "auth": {
        "password": "<string>",
        "user": "<string>"
      },
      "bindExchange": {
        "exchange": "<string>",
        "routingKey": "<string>"
      },
      "deadLetterExchange": "<string>",
      "host": "<string>",
      "port": "<string>",
      "queue": "<string>",
      "schema": "<string>",
      "vhost": "<string>"
    },
    "google": {
      "project_id": "<string>",
      "service_account": [
        123
      ],
      "subscription_id": "<string>"
    },
    "kafka": {
      "auth": {
        "hash": "<string>",
        "password": "<string>",
        "tls": true,
        "type": "<string>",
        "username": "<string>"
      },
      "brokers": [
        "<string>"
      ],
      "consumer_group_id": "<string>",
      "topic_name": "<string>"
    },
    "sqs": {
      "access_key_id": "<string>",
      "default_region": "<string>",
      "queue_name": "<string>",
      "secret_key": "<string>"
    },
    "type": "sqs",
    "workers": 123
  },
  "type": "http",
  "verifier": {
    "api_key": {
      "header_name": "<string>",
      "header_value": "<string>"
    },
    "basic_auth": {
      "password": "<string>",
      "username": "<string>"
    },
    "hmac": {
      "encoding": "base64",
      "hash": "<string>",
      "header": "<string>",
      "secret": "<string>"
    },
    "type": "noop"
  }
}'
{
  "message": "<string>",
  "status": true,
  "data": {
    "body_function": "<string>",
    "created_at": "<string>",
    "custom_response": {
      "body": "<string>",
      "content_type": "<string>"
    },
    "deleted_at": "<string>",
    "forward_headers": [
      "<string>"
    ],
    "header_function": "<string>",
    "idempotency_keys": [
      "<string>"
    ],
    "is_disabled": true,
    "mask_id": "<string>",
    "name": "<string>",
    "project_id": "<string>",
    "provider": "github",
    "provider_config": {
      "twitter": {
        "crc_verified_at": "<string>"
      }
    },
    "pub_sub": {
      "amqp": {
        "auth": {
          "password": "<string>",
          "user": "<string>"
        },
        "bindedExchange": "<string>",
        "deadLetterExchange": "<string>",
        "host": "<string>",
        "port": "<string>",
        "queue": "<string>",
        "routingKey": "<string>",
        "schema": "<string>",
        "vhost": "<string>"
      },
      "google": {
        "project_id": "<string>",
        "service_account": [
          123
        ],
        "subscription_id": "<string>"
      },
      "kafka": {
        "auth": {
          "hash": "<string>",
          "password": "<string>",
          "tls": true,
          "type": "<string>",
          "username": "<string>"
        },
        "brokers": [
          "<string>"
        ],
        "consumer_group_id": "<string>",
        "topic_name": "<string>"
      },
      "sqs": {
        "access_key_id": "<string>",
        "default_region": "<string>",
        "queue_name": "<string>",
        "secret_key": "<string>"
      },
      "type": "sqs",
      "workers": 123
    },
    "type": "http",
    "uid": "<string>",
    "updated_at": "<string>",
    "url": "<string>",
    "verifier": {
      "api_key": {
        "header_name": "<string>",
        "header_value": "<string>"
      },
      "basic_auth": {
        "password": "<string>",
        "username": "<string>"
      },
      "hmac": {
        "encoding": "base64",
        "hash": "<string>",
        "header": "<string>",
        "secret": "<string>"
      },
      "type": "noop"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
projectID
string
required

Project ID

​
sourceID
string
required

source id

Body

application/json
Source Details
​
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
Accepted
​
message
string
​
status
boolean
​
data
object

Was this page helpful?

Retrieve a sourceDelete a source