Create a broadcast event

POST

projects

{projectID}

events

broadcast

Authorizations

Authorization

string

headerrequired

Path Parameters

projectID

string

required

Project ID

Body

application/json

acknowledged_at

string

custom_headers

object

Specifies custom headers you want convoy to add when the event is dispatched to your endpoint

data

object

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

201 - application/json

message

string

status

boolean

data

object

data.acknowledged_at

string

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

string[]

data.event_type

string

data.headers

object

data.idempotency_key

string

data.is_duplicate_event

boolean

data.metadata

string

data.project_id

string

data.raw

string

data.source_id

string

data.source_metadata

object

data.source_metadata.body_function

string

data.source_metadata.created_at

string

data.source_metadata.custom_response

object

data.source_metadata.deleted_at

string

data.source_metadata.forward_headers

string[]

data.source_metadata.header_function

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

object

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

enum<string>

Available options:

Processing,

Failure,

Success,

Retry,

Pending

data.uid

string

data.updated_at

string

data.url_query_params

string

Was this page helpful?

Create an event Batch replay events

Introduction

Endpoints

Event Deliveries

Event Types

Delivery Attempts

Events

Meta Events

Portal Links

Sources

Subscriptions

Create a broadcast event

Authorizations

Path Parameters

Body

Response