Events
Create a broadcast event
- 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
Events
Create a broadcast event
This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type.
POST
/
v1
/
projects
/
{projectID}
/
events
/
broadcast
Authorization
string
*
Authorization
Required
string
projectID
string
*
projectID
Required
string
Project ID
object
*
custom_headers
object
custom_headers
object
Specifies custom headers you want convoy to add when the event is dispatched to your endpoint
data
array
data
array
Data is an arbitrary JSON value that gets sent as the body of the webhook to the endpoints
event_type
string
event_type
string
Event Type is used for filtering and debugging e.g invoice.paid
idempotency_key
string
idempotency_key
string
Specify a key for event deduplication
Authorizations
Authorization
string
headerrequiredPath Parameters
projectID
string
requiredProject ID
Body
application/json
custom_headers
object
Specifies custom headers you want convoy to add when the event is dispatched to your endpoint
data
integer[]
Data is an arbitrary JSON value that gets sent as the body of the webhook to the endpoints
event_type
string
Event Type is used for filtering and debugging e.g invoice.paid
idempotency_key
string
Specify a key for event deduplication
Response
200 - application/json
message
string
status
boolean
data
object
data.app_id
string
Deprecated
data.created_at
string
data.data
integer[]
Data is an arbitrary JSON value that gets sent as the body of the webhook to the endpoints
data.deleted_at
string
data.endpoint_metadata
object[]
data.endpoint_metadata.advanced_signatures
boolean
data.endpoint_metadata.authentication
object
data.endpoint_metadata.authentication.api_key
object
data.endpoint_metadata.authentication.api_key.header_name
string
data.endpoint_metadata.authentication.api_key.header_value
string
data.endpoint_metadata.authentication.type
enum<string>
Available options:
api_key data.endpoint_metadata.created_at
string
data.endpoint_metadata.deleted_at
string
data.endpoint_metadata.description
string
data.endpoint_metadata.events
integer
data.endpoint_metadata.http_timeout
integer
data.endpoint_metadata.name
string
data.endpoint_metadata.owner_id
string
data.endpoint_metadata.project_id
string
data.endpoint_metadata.rate_limit
integer
data.endpoint_metadata.rate_limit_duration
integer
data.endpoint_metadata.secrets
object[]
data.endpoint_metadata.secrets.created_at
string
data.endpoint_metadata.secrets.deleted_at
string
data.endpoint_metadata.secrets.expires_at
string
data.endpoint_metadata.secrets.uid
string
data.endpoint_metadata.secrets.updated_at
string
data.endpoint_metadata.secrets.value
string
data.endpoint_metadata.slack_webhook_url
string
data.endpoint_metadata.status
enum<string>
Available options:
active, inactive, pending, paused data.endpoint_metadata.support_email
string
data.endpoint_metadata.uid
string
data.endpoint_metadata.updated_at
string
data.endpoint_metadata.url
string
data.endpoints
string[]
data.event_type
string
data.headers
object
data.idempotency_key
string
data.is_duplicate_event
boolean
data.project_id
string
data.raw
string
data.source_id
string
data.source_metadata
object
data.source_metadata.created_at
string
data.source_metadata.custom_response
object
data.source_metadata.custom_response.body
string
data.source_metadata.custom_response.content_type
string
data.source_metadata.deleted_at
string
data.source_metadata.forward_headers
string[]
data.source_metadata.idempotency_keys
string[]
data.source_metadata.is_disabled
boolean
data.source_metadata.mask_id
string
data.source_metadata.name
string
data.source_metadata.project_id
string
data.source_metadata.provider
enum<string>
Available options:
github, twitter, shopify data.source_metadata.provider_config
object
data.source_metadata.provider_config.twitter
object
data.source_metadata.provider_config.twitter.crc_verified_at
string
data.source_metadata.pub_sub
object
data.source_metadata.pub_sub.amqp
object
data.source_metadata.pub_sub.amqp.auth
object
data.source_metadata.pub_sub.amqp.auth.password
string
data.source_metadata.pub_sub.amqp.auth.user
string
data.source_metadata.pub_sub.amqp.bindedExchange
string
data.source_metadata.pub_sub.amqp.deadLetterExchange
string
data.source_metadata.pub_sub.amqp.host
string
data.source_metadata.pub_sub.amqp.port
string
data.source_metadata.pub_sub.amqp.queue
string
data.source_metadata.pub_sub.amqp.routingKey
string
data.source_metadata.pub_sub.amqp.schema
string
data.source_metadata.pub_sub.google
object
data.source_metadata.pub_sub.google.project_id
string
data.source_metadata.pub_sub.google.service_account
integer[]
data.source_metadata.pub_sub.google.subscription_id
string
data.source_metadata.pub_sub.kafka
object
data.source_metadata.pub_sub.kafka.auth
object
data.source_metadata.pub_sub.kafka.auth.hash
string
data.source_metadata.pub_sub.kafka.auth.password
string
data.source_metadata.pub_sub.kafka.auth.tls
boolean
data.source_metadata.pub_sub.kafka.auth.type
string
data.source_metadata.pub_sub.kafka.auth.username
string
data.source_metadata.pub_sub.kafka.brokers
string[]
data.source_metadata.pub_sub.kafka.consumer_group_id
string
data.source_metadata.pub_sub.kafka.topic_name
string
data.source_metadata.pub_sub.sqs
object
data.source_metadata.pub_sub.sqs.access_key_id
string
data.source_metadata.pub_sub.sqs.default_region
string
data.source_metadata.pub_sub.sqs.queue_name
string
data.source_metadata.pub_sub.sqs.secret_key
string
data.source_metadata.pub_sub.type
enum<string>
Available options:
sqs, google, kafka, amqp data.source_metadata.pub_sub.workers
integer
data.source_metadata.type
enum<string>
Available options:
http, rest_api, pub_sub, db_change_stream data.source_metadata.uid
string
data.source_metadata.updated_at
string
data.source_metadata.url
string
data.source_metadata.verifier
object
data.source_metadata.verifier.api_key
object
data.source_metadata.verifier.api_key.header_name
string
data.source_metadata.verifier.api_key.header_value
string
data.source_metadata.verifier.basic_auth
object
data.source_metadata.verifier.basic_auth.password
string
data.source_metadata.verifier.basic_auth.username
string
data.source_metadata.verifier.hmac
object
data.source_metadata.verifier.hmac.encoding
enum<string>
Available options:
base64, hex data.source_metadata.verifier.hmac.hash
string
data.source_metadata.verifier.hmac.header
string
data.source_metadata.verifier.hmac.secret
string
data.source_metadata.verifier.type
enum<string>
Available options:
noop, hmac, basic_auth, api_key data.uid
string
data.updated_at
string
data.url_query_params
string
Was this page helpful?