Sources
Create a source
- Community
- GitHub
- Tutorials
- GETList all endpoints
- POSTCreate an endpoint
- GETRetrieve endpoint
- PUTUpdate an endpoint
- DELDelete endpoint
- PUTRoll endpoint secret
- PUTPause endpoint
- GETList all event deliveries
- POSTBatch retry event delivery
- POSTForce retry event delivery
- GETRetrieve an event delivery
- PUTRetry event delivery
- GETList all events
- POSTCreate an event
- POSTCreate a broadcast event
- POSTBatch replay events
- POSTDynamic Events
- POSTFan out an event
- GETRetrieve an event
- PUTReplay event
- GETList all portal links
- POSTCreate a portal link
- GETRetrieve a portal link
- PUTUpdate a portal link
- PUTRevoke a portal link
Endpoints
Event Deliveries
Events
Portal Links
Sources
Create a source
This endpoint creates a source
POST
/
v1
/
projects
/
{projectID}
/
sources
Authorization
string
*
Authorization
Required
string
projectID
string
*
projectID
Required
string
Project ID
object
*
custom_response
object
custom_response
object
Custom response is used to define a custom response for incoming webhooks project sources only.
body
string
body
string
content_type
string
content_type
string
idempotency_keys
array
idempotency_keys
array
IdempotencyKeys are used to specify parts of a webhook request to uniquely identify the event in an incoming webhooks project.
name
string
name
string
Source name.
provider
enum<string>
provider
enum<string>
Use this to specify one of our predefined source types.
pub_sub
object
pub_sub
object
PubSub are used to specify message broker sources for outgoing webhooks projects.
amqp
object
amqp
object
auth
object
auth
object
password
string
password
string
user
string
user
string
bindExchange
object
bindExchange
object
exchange
string
exchange
string
routingKey
string
routingKey
string
deadLetterExchange
string
deadLetterExchange
string
host
string
host
string
port
string
port
string
queue
string
queue
string
schema
string
schema
string
google
object
google
object
project_id
string
project_id
string
service_account
array
service_account
array
subscription_id
string
subscription_id
string
kafka
object
kafka
object
auth
object
auth
object
hash
string
hash
string
password
string
password
string
tls
boolean
tls
boolean
type
string
type
string
username
string
username
string
brokers
array
brokers
array
consumer_group_id
string
consumer_group_id
string
topic_name
string
topic_name
string
sqs
object
sqs
object
access_key_id
string
access_key_id
string
default_region
string
default_region
string
queue_name
string
queue_name
string
secret_key
string
secret_key
string
type
enum<string>
type
enum<string>
workers
integer
workers
integer
type
enum<string>
type
enum<string>
Source Type.
verifier
object
verifier
object
Verifiers are used to verify webhook events ingested in incoming webhooks projects.
api_key
object
api_key
object
header_name
string
header_name
string
header_value
string
header_value
string
basic_auth
object
basic_auth
object
password
string
password
string
username
string
username
string
hmac
object
hmac
object
encoding
enum<string>
encoding
enum<string>
hash
string
hash
string
header
string
header
string
secret
string
secret
string
type
enum<string>
type
enum<string>
Authorizations
Authorization
string
headerrequiredPath Parameters
projectID
string
requiredProject ID
Body
application/json
custom_response
object
Custom response is used to define a custom response for incoming webhooks project sources only.
custom_response.body
string
custom_response.content_type
string
idempotency_keys
string[]
IdempotencyKeys are used to specify parts of a webhook request to uniquely identify the event in an incoming webhooks project.
name
string
Source name.
provider
enum<string>
Use this to specify one of our predefined source types.
Available options:
github, twitter, shopify pub_sub
object
PubSub are used to specify message broker sources for outgoing webhooks projects.
pub_sub.amqp
object
pub_sub.amqp.auth
object
pub_sub.amqp.auth.password
string
pub_sub.amqp.auth.user
string
pub_sub.amqp.bindExchange
object
pub_sub.amqp.bindExchange.exchange
string
pub_sub.amqp.bindExchange.routingKey
string
pub_sub.amqp.deadLetterExchange
string
pub_sub.amqp.host
string
pub_sub.amqp.port
string
pub_sub.amqp.queue
string
pub_sub.amqp.schema
string
pub_sub.google
object
pub_sub.google.project_id
string
pub_sub.google.service_account
integer[]
pub_sub.google.subscription_id
string
pub_sub.kafka
object
pub_sub.kafka.auth
object
pub_sub.kafka.auth.hash
string
pub_sub.kafka.auth.password
string
pub_sub.kafka.auth.tls
boolean
pub_sub.kafka.auth.type
string
pub_sub.kafka.auth.username
string
pub_sub.kafka.brokers
string[]
pub_sub.kafka.consumer_group_id
string
pub_sub.kafka.topic_name
string
pub_sub.sqs
object
pub_sub.sqs.access_key_id
string
pub_sub.sqs.default_region
string
pub_sub.sqs.queue_name
string
pub_sub.sqs.secret_key
string
pub_sub.type
enum<string>
Available options:
sqs, google, kafka, amqp pub_sub.workers
integer
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.
verifier.api_key
object
verifier.api_key.header_name
string
verifier.api_key.header_value
string
verifier.basic_auth
object
verifier.basic_auth.password
string
verifier.basic_auth.username
string
verifier.hmac
object
verifier.hmac.encoding
enum<string>
Available options:
base64, hex verifier.hmac.hash
string
verifier.hmac.header
string
verifier.hmac.secret
string
verifier.type
enum<string>
Available options:
noop, hmac, basic_auth, api_key Response
200 - application/json
message
string
status
boolean
data
object
data.created_at
string
data.custom_response
object
data.custom_response.body
string
data.custom_response.content_type
string
data.deleted_at
string
data.forward_headers
string[]
data.idempotency_keys
string[]
data.is_disabled
boolean
data.mask_id
string
data.name
string
data.project_id
string
data.provider
enum<string>
Available options:
github, twitter, shopify data.provider_config
object
data.provider_config.twitter
object
data.provider_config.twitter.crc_verified_at
string
data.pub_sub
object
data.pub_sub.amqp
object
data.pub_sub.amqp.auth
object
data.pub_sub.amqp.auth.password
string
data.pub_sub.amqp.auth.user
string
data.pub_sub.amqp.bindedExchange
string
data.pub_sub.amqp.deadLetterExchange
string
data.pub_sub.amqp.host
string
data.pub_sub.amqp.port
string
data.pub_sub.amqp.queue
string
data.pub_sub.amqp.routingKey
string
data.pub_sub.amqp.schema
string
data.pub_sub.google
object
data.pub_sub.google.project_id
string
data.pub_sub.google.service_account
integer[]
data.pub_sub.google.subscription_id
string
data.pub_sub.kafka
object
data.pub_sub.kafka.auth
object
data.pub_sub.kafka.auth.hash
string
data.pub_sub.kafka.auth.password
string
data.pub_sub.kafka.auth.tls
boolean
data.pub_sub.kafka.auth.type
string
data.pub_sub.kafka.auth.username
string
data.pub_sub.kafka.brokers
string[]
data.pub_sub.kafka.consumer_group_id
string
data.pub_sub.kafka.topic_name
string
data.pub_sub.sqs
object
data.pub_sub.sqs.access_key_id
string
data.pub_sub.sqs.default_region
string
data.pub_sub.sqs.queue_name
string
data.pub_sub.sqs.secret_key
string
data.pub_sub.type
enum<string>
Available options:
sqs, google, kafka, amqp data.pub_sub.workers
integer
data.type
enum<string>
Available options:
http, rest_api, pub_sub, db_change_stream data.uid
string
data.updated_at
string
data.url
string
data.verifier
object
data.verifier.api_key
object
data.verifier.api_key.header_name
string
data.verifier.api_key.header_value
string
data.verifier.basic_auth
object
data.verifier.basic_auth.password
string
data.verifier.basic_auth.username
string
data.verifier.hmac
object
data.verifier.hmac.encoding
enum<string>
Available options:
base64, hex data.verifier.hmac.hash
string
data.verifier.hmac.header
string
data.verifier.hmac.secret
string
data.verifier.type
enum<string>
Available options:
noop, hmac, basic_auth, api_key Was this page helpful?