Skip to main content
POST
/
v1
/
projects
/
{projectID}
/
events
/
broadcast
Create a broadcast event
curl --request POST \
  --url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/events/broadcast \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "acknowledged_at": "<string>",
  "custom_headers": {},
  "data": {},
  "event_type": "<string>",
  "idempotency_key": "<string>"
}
'
{
  "message": "<string>",
  "status": true,
  "data": {
    "acknowledged_at": "<string>",
    "app_id": "<string>",
    "created_at": "<string>",
    "data": [
      123
    ],
    "deleted_at": "<string>",
    "endpoint_metadata": [
      {
        "advanced_signatures": true,
        "authentication": {
          "api_key": {
            "header_name": "<string>",
            "header_value": "<string>"
          },
          "type": "api_key"
        },
        "created_at": "<string>",
        "deleted_at": "<string>",
        "description": "<string>",
        "events": 123,
        "failure_rate": 123,
        "http_timeout": 123,
        "name": "<string>",
        "owner_id": "<string>",
        "project_id": "<string>",
        "rate_limit": 123,
        "rate_limit_duration": 123,
        "secrets": [
          {
            "created_at": "<string>",
            "deleted_at": "<string>",
            "expires_at": "<string>",
            "uid": "<string>",
            "updated_at": "<string>",
            "value": "<string>"
          }
        ],
        "slack_webhook_url": "<string>",
        "status": "active",
        "support_email": "<string>",
        "uid": "<string>",
        "updated_at": "<string>",
        "url": "<string>"
      }
    ],
    "endpoints": [
      "<string>"
    ],
    "event_type": "<string>",
    "headers": {},
    "idempotency_key": "<string>",
    "is_duplicate_event": true,
    "metadata": "<string>",
    "project_id": "<string>",
    "raw": "<string>",
    "source_id": "<string>",
    "source_metadata": {
      "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"
      }
    },
    "status": "Processing",
    "uid": "<string>",
    "updated_at": "<string>",
    "url_query_params": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
projectID
string
required

Project ID

Body

application/json

Broadcast Event Details

​
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

Created

​
message
string
​
status
boolean
​
data
object