{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Convoy","colors":{"primary":"#2780F1","light":"#739FEA","dark":"#477BD3"},"logo":{"light":"https://mintcdn.com/convoy/ZDnFuM112cm76jYI/logo/light.svg?fit=max\u0026auto=format\u0026n=ZDnFuM112cm76jYI\u0026q=85\u0026s=3d933080cf301678d7fafe5f50d4ec12","dark":"https://mintcdn.com/convoy/vmJyPsa9GtTKdw-a/logo/dark.svg?fit=max\u0026auto=format\u0026n=vmJyPsa9GtTKdw-a\u0026q=85\u0026s=7d0ea6ef778d7ed00854dc455e9b12ea"},"favicon":"https://mintcdn.com/convoy/Ckv6F6QCAG1QB-UF/favicon.png?fit=max\u0026auto=format\u0026n=Ckv6F6QCAG1QB-UF\u0026q=85\u0026s=cc975351cd155c7828899933dca4f999","background":{"image":"https://mintcdn.com/convoy/Ckv6F6QCAG1QB-UF/background.png?fit=max\u0026auto=format\u0026n=Ckv6F6QCAG1QB-UF\u0026q=85\u0026s=165fcf2460dff22b7e1c8d84d0741646"},"navbar":{"primary":{"type":"github","label":"GitHub","href":"https://github.com/frain-dev/convoy"}},"footer":{"socials":{"twitter":"https://twitter.com/getconvoy?lang=en","linkedin":"https://www.linkedin.com/company/convoy-webhooks"}},"seo":{"metatags":{"canonical":"https://www.getconvoy.io/docs"}},"integrations":{"posthog":{"apiKey":"phc_X7uV1sRNzjoTmWp8uXYrzrfrdUtGdMRTEEklRNt04eb","apiHost":"https://us.i.posthog.com"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://convoy-community.slack.com/join/shared_invite/zt-xiuuoj0m-yPp~ylfYMCV9s038QL0IUQ#/shared-invite/email"},{"anchor":"GitHub","icon":"github","href":"https://github.com/frain-dev/convoy"},{"anchor":"Status","icon":"signal","href":"https://status.getconvoy.io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"convoy","hasAudioNarration":false,"actualSubdomain":"convoy","customDomains":["getconvoy.io"],"gitSource":{"type":"github","owner":"frain-dev","repo":"convoy-website","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae50032dbe71608b89029e5","collectionId":"118644cb-011e-4922-8a20-f36a66055bb0","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae50032dbe71608b89029e5"},"feedback":{"thumbs":true,"edits":false,"issues":false},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae50032dbe71608b89029e5","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Reference","count":70},{"language":"default","tag":"Documentation","count":68},{"language":"default","tag":"Product Manual","count":28},{"language":"default","tag":"Glossary","count":13},{"language":"default","tag":"Endpoints","count":9},{"language":"default","tag":"Events","count":8},{"language":"default","tag":"Subscription Filters","count":8},{"language":"default","tag":"Deployment","count":8},{"language":"default","tag":"Subscriptions","count":7},{"language":"default","tag":"Portal Links","count":6}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/events/create-a-broadcast-event","slug":"/api-reference/events/create-a-broadcast-event","pageMetadata":{"openapi":"post /v1/projects/{projectID}/events/broadcast","title":"Create a broadcast event","description":"This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type.","href":"/api-reference/events/create-a-broadcast-event"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`201`}),` body includes `,_jsx(_components.code,{children:`uid`}),` (the event id). Use it to follow the send:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/api-reference/events/retrieve-an-event`,children:`Retrieve the event`})}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-reference/event-deliveries/list-all-event-deliveries`,children:`List deliveries`}),` (`,_jsx(_components.code,{children:`eventId`}),` or `,_jsx(_components.code,{children:`idempotencyKey`}),`)`]}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/api-reference/event-deliveries/retrieve-an-event-delivery`,children:`Get a delivery`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/api-reference/event-deliveries/retry-event-delivery`,children:`Retry a delivery`})}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /v1/projects/{projectID}/events/broadcast","title":"Create a broadcast event","description":"This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type.","href":"/api-reference/events/create-a-broadcast-event"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"parameters":["aca3c864-95fc-4b1e-bb86-58522f2aa496"],"responses":{"201":"5f22c854-21ac-4c10-89e2-ec486bbae6f9","400":"a0dad010-442b-4184-aef6-6409aed490b1","401":"67e0f85e-bdf0-4b6b-a44d-f5bb6c73324b","404":"9908f30c-c4fd-4f92-8a0b-6e84c991b337"},"security":["618666f8-b294-47b6-b7ea-b484e8a0db4d"],"tags":["Events"],"description":"This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type.","operationId":"CreateBroadcastEvent","requestBody":"2281cc87-af69-4915-9756-d560665e1094","summary":"Create a broadcast event","method":"post","type":"path","servers":["ea05ed13-6fe8-4fcf-a55a-7dd4fbef101c","88107b80-52be-4d32-be46-16468ea6dbc5"],"path":"/v1/projects/{projectID}/events/broadcast","baseUrlOptions":["https://us.getconvoy.cloud/api","https://eu.getconvoy.cloud/api"],"title":"Create a broadcast event","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"aca3c864-95fc-4b1e-bb86-58522f2aa496":{"description":"Project ID","in":"path","name":"projectID","required":true,"schema":{"type":"string","isRequired":true,"description":"Project ID","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"acknowledged_at":{"type":"string","uniqueKey":"acknowledged_at","typeLabel":"string"},"custom_headers":{"additionalProperties":{"type":"string","uniqueKey":"custom_headers.additionalProperties","typeLabel":"string"},"description":"Specifies custom headers you want convoy to add when the event is dispatched to your endpoint","type":"object","uniqueKey":"custom_headers","typeLabel":"object"},"data":{"description":"Data is an arbitrary JSON value that gets sent as the body of the\nwebhook to the endpoints","type":"object","uniqueKey":"data","typeLabel":"object"},"event_type":{"description":"Event Type is used for filtering and debugging e.g invoice.paid","type":"string","uniqueKey":"event_type","typeLabel":"string"},"idempotency_key":{"description":"Specify a key for event deduplication","type":"string","uniqueKey":"idempotency_key","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"acknowledged_at":"\u003cstring>","custom_headers":{},"data":{},"event_type":"\u003cstring>","idempotency_key":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Broadcast Event Details","required":true,"exampleType":"generated"},"responses":{"5f22c854-21ac-4c10-89e2-ec486bbae6f9":{"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"status":{"type":"boolean","uniqueKey":"status","typeLabel":"boolean"},"data":{"properties":{"acknowledged_at":{"type":"string","uniqueKey":"data.acknowledged_at","typeLabel":"string"},"app_id":{"description":"Deprecated","type":"string","uniqueKey":"data.app_id","typeLabel":"string"},"created_at":{"type":"string","uniqueKey":"data.created_at","typeLabel":"string"},"data":{"description":"Data is an arbitrary JSON value that gets sent as the body of the\nwebhook to the endpoints","items":{"type":"integer","uniqueKey":"data.data.items.[INDEX]","typeLabel":"integer"},"type":"array","uniqueKey":"data.data","typeLabel":"integer[]"},"deleted_at":{"type":"string","uniqueKey":"data.deleted_at","typeLabel":"string"},"endpoint_metadata":{"items":{"properties":{"advanced_signatures":{"type":"boolean","uniqueKey":"data.endpoint_metadata.items.[INDEX].advanced_signatures","typeLabel":"boolean"},"authentication":{"properties":{"api_key":{"properties":{"header_name":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.api_key.header_name","typeLabel":"string"},"header_value":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.api_key.header_value","typeLabel":"string"}},"type":"object","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.api_key","typeLabel":"object"},"basic_auth":{"properties":{"password":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.basic_auth.password","typeLabel":"string"},"username":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.basic_auth.username","typeLabel":"string"}},"type":"object","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.basic_auth","typeLabel":"object"},"oauth2":{"properties":{"audience":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.audience","typeLabel":"string"},"authentication_type":{"enum":["shared_secret","client_assertion"],"type":"string","x-enum-varnames":["SharedSecretAuth","ClientAssertionAuth"],"uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.authentication_type","typeLabel":"enum\u003cstring>"},"client_id":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.client_id","typeLabel":"string"},"client_secret":{"description":"Encrypted at rest","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.client_secret","typeLabel":"string"},"expiry_time_unit":{"type":"string","description":"Expiry time unit (seconds, milliseconds, minutes, hours)","enum":["seconds","milliseconds","minutes","hours"],"x-enum-varnames":["ExpiryTimeUnitSeconds","ExpiryTimeUnitMilliseconds","ExpiryTimeUnitMinutes","ExpiryTimeUnitHours"],"uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.expiry_time_unit","typeLabel":"enum\u003cstring>"},"field_mapping":{"type":"object","description":"Field mapping for flexible token response parsing","properties":{"access_token":{"description":"Field name for access token (e.g., \"accessToken\", \"access_token\", \"token\")","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.field_mapping.access_token","typeLabel":"string"},"expires_in":{"description":"Field name for expiry time (e.g., \"expiresIn\", \"expires_in\", \"expiresAt\")","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.field_mapping.expires_in","typeLabel":"string"},"token_type":{"description":"Field name for token type (e.g., \"tokenType\", \"token_type\")","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.field_mapping.token_type","typeLabel":"string"}},"uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.field_mapping","typeLabel":"object"},"grant_type":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.grant_type","typeLabel":"string"},"issuer":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.issuer","typeLabel":"string"},"scope":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.scope","typeLabel":"string"},"signing_algorithm":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_algorithm","typeLabel":"string"},"signing_key":{"type":"object","description":"Encrypted at rest","properties":{"crv":{"description":"EC (Elliptic Curve) key fields","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_key.crv","typeLabel":"string"},"d":{"description":"Private key (EC only)","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_key.d","typeLabel":"string"},"dp":{"description":"RSA first factor CRT exponent (RSA private key only)","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_key.dp","typeLabel":"string"},"dq":{"description":"RSA second factor CRT exponent (RSA private key only)","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_key.dq","typeLabel":"string"},"e":{"description":"RSA public exponent (RSA only)","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_key.e","typeLabel":"string"},"kid":{"description":"Key ID","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_key.kid","typeLabel":"string"},"kty":{"description":"Key type: \"EC\" or \"RSA\"","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_key.kty","typeLabel":"string"},"n":{"description":"RSA key fields","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_key.n","typeLabel":"string"},"p":{"description":"RSA first prime factor (RSA private key only)","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_key.p","typeLabel":"string"},"q":{"description":"RSA second prime factor (RSA private key only)","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_key.q","typeLabel":"string"},"qi":{"description":"RSA first CRT coefficient (RSA private key only)","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_key.qi","typeLabel":"string"},"x":{"description":"X coordinate (EC only)","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_key.x","typeLabel":"string"},"y":{"description":"Y coordinate (EC only)","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_key.y","typeLabel":"string"}},"uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.signing_key","typeLabel":"object"},"subject":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.subject","typeLabel":"string"},"url":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2.url","typeLabel":"string"}},"type":"object","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.oauth2","typeLabel":"object"},"type":{"enum":["api_key","oauth2","basic_auth"],"type":"string","x-enum-varnames":["APIKeyAuthentication","OAuth2Authentication","BasicAuthentication"],"uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication.type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"data.endpoint_metadata.items.[INDEX].authentication","typeLabel":"object"},"cb_state":{"description":"CBState is the circuit breaker state (\"open\", \"half-open\", \"closed\") so the UI\ncan reflect a tripped breaker on the endpoint status. Nil when CB is\noff/unlicensed or has no sample for this endpoint.","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].cb_state","typeLabel":"string"},"content_type":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].content_type","typeLabel":"string"},"created_at":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].created_at","typeLabel":"string"},"deleted_at":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].deleted_at","typeLabel":"string"},"description":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].description","typeLabel":"string"},"events":{"type":"integer","uniqueKey":"data.endpoint_metadata.items.[INDEX].events","typeLabel":"integer"},"failure_count":{"type":"integer","uniqueKey":"data.endpoint_metadata.items.[INDEX].failure_count","typeLabel":"integer"},"failure_rate":{"description":"FailureRate is the circuit breaker's rolling failure rate for this endpoint.\nIt is a pointer so the API can return null when no rate was computed (circuit\nbreaker feature off, or sampler not running), distinct from a genuine 0%.","type":"number","uniqueKey":"data.endpoint_metadata.items.[INDEX].failure_rate","typeLabel":"number"},"http_timeout":{"type":"integer","uniqueKey":"data.endpoint_metadata.items.[INDEX].http_timeout","typeLabel":"integer"},"mtls_client_cert":{"type":"object","description":"mTLS client certificate configuration","properties":{"client_cert":{"description":"ClientCert is the client certificate PEM string","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].mtls_client_cert.client_cert","typeLabel":"string"},"client_key":{"description":"ClientKey is the client private key PEM string","type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].mtls_client_cert.client_key","typeLabel":"string"}},"uniqueKey":"data.endpoint_metadata.items.[INDEX].mtls_client_cert","typeLabel":"object"},"name":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].name","typeLabel":"string"},"owner_id":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].owner_id","typeLabel":"string"},"period_failure_rate":{"description":"PeriodFailureRate is the period failure rate from event_deliveries,\n(Failure+Retry)/(Success+Failure+Retry). Retry counts as failed-so-far.\nNil when the range has no counted deliveries; sibling counts are transient.","type":"number","uniqueKey":"data.endpoint_metadata.items.[INDEX].period_failure_rate","typeLabel":"number"},"project_id":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].project_id","typeLabel":"string"},"rate_limit":{"type":"integer","uniqueKey":"data.endpoint_metadata.items.[INDEX].rate_limit","typeLabel":"integer"},"rate_limit_duration":{"type":"integer","uniqueKey":"data.endpoint_metadata.items.[INDEX].rate_limit_duration","typeLabel":"integer"},"retry_count":{"type":"integer","uniqueKey":"data.endpoint_metadata.items.[INDEX].retry_count","typeLabel":"integer"},"secrets":{"items":{"properties":{"created_at":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].secrets.items.[INDEX].created_at","typeLabel":"string"},"deleted_at":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].secrets.items.[INDEX].deleted_at","typeLabel":"string"},"expires_at":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].secrets.items.[INDEX].expires_at","typeLabel":"string"},"uid":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].secrets.items.[INDEX].uid","typeLabel":"string"},"updated_at":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].secrets.items.[INDEX].updated_at","typeLabel":"string"},"value":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].secrets.items.[INDEX].value","typeLabel":"string"}},"type":"object","uniqueKey":"data.endpoint_metadata.items.[INDEX].secrets.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.endpoint_metadata.items.[INDEX].secrets","typeLabel":"object[]"},"slack_webhook_url":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].slack_webhook_url","typeLabel":"string"},"status":{"enum":["active","inactive","paused"],"type":"string","x-enum-varnames":["ActiveEndpointStatus","InactiveEndpointStatus","PausedEndpointStatus"],"uniqueKey":"data.endpoint_metadata.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"success_count":{"type":"integer","uniqueKey":"data.endpoint_metadata.items.[INDEX].success_count","typeLabel":"integer"},"support_email":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].support_email","typeLabel":"string"},"uid":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].uid","typeLabel":"string"},"updated_at":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].updated_at","typeLabel":"string"},"url":{"type":"string","uniqueKey":"data.endpoint_metadata.items.[INDEX].url","typeLabel":"string"}},"type":"object","uniqueKey":"data.endpoint_metadata.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.endpoint_metadata","typeLabel":"object[]"},"endpoints":{"items":{"type":"string","uniqueKey":"data.endpoints.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"data.endpoints","typeLabel":"string[]"},"event_type":{"type":"string","uniqueKey":"data.event_type","typeLabel":"string"},"headers":{"additionalProperties":{"items":{"type":"string","uniqueKey":"data.headers.additionalProperties.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"data.headers.additionalProperties","typeLabel":"string[]"},"type":"object","uniqueKey":"data.headers","typeLabel":"object"},"idempotency_key":{"type":"string","uniqueKey":"data.idempotency_key","typeLabel":"string"},"is_duplicate_event":{"type":"boolean","uniqueKey":"data.is_duplicate_event","typeLabel":"boolean"},"metadata":{"type":"string","uniqueKey":"data.metadata","typeLabel":"string"},"project_id":{"type":"string","uniqueKey":"data.project_id","typeLabel":"string"},"raw":{"type":"string","uniqueKey":"data.raw","typeLabel":"string"},"source_id":{"type":"string","uniqueKey":"data.source_id","typeLabel":"string"},"source_metadata":{"properties":{"body_function":{"type":"string","uniqueKey":"data.source_metadata.body_function","typeLabel":"string"},"created_at":{"type":"string","uniqueKey":"data.source_metadata.created_at","typeLabel":"string"},"custom_response":{"properties":{"body":{"type":"string","uniqueKey":"data.source_metadata.custom_response.body","typeLabel":"string"},"content_type":{"type":"string","uniqueKey":"data.source_metadata.custom_response.content_type","typeLabel":"string"}},"type":"object","uniqueKey":"data.source_metadata.custom_response","typeLabel":"object"},"deleted_at":{"type":"string","uniqueKey":"data.source_metadata.deleted_at","typeLabel":"string"},"event_type_location":{"type":"string","uniqueKey":"data.source_metadata.event_type_location","typeLabel":"string"},"forward_headers":{"items":{"type":"string","uniqueKey":"data.source_metadata.forward_headers.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"data.source_metadata.forward_headers","typeLabel":"string[]"},"header_function":{"type":"string","uniqueKey":"data.source_metadata.header_function","typeLabel":"string"},"idempotency_keys":{"items":{"type":"string","uniqueKey":"data.source_metadata.idempotency_keys.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"data.source_metadata.idempotency_keys","typeLabel":"string[]"},"is_disabled":{"type":"boolean","uniqueKey":"data.source_metadata.is_disabled","typeLabel":"boolean"},"mask_id":{"type":"string","uniqueKey":"data.source_metadata.mask_id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"data.source_metadata.name","typeLabel":"string"},"project_id":{"type":"string","uniqueKey":"data.source_metadata.project_id","typeLabel":"string"},"provider":{"enum":["github","twitter","shopify"],"type":"string","x-enum-varnames":["GithubSourceProvider","TwitterSourceProvider","ShopifySourceProvider"],"uniqueKey":"data.source_metadata.provider","typeLabel":"enum\u003cstring>"},"provider_config":{"properties":{"twitter":{"properties":{"crc_verified_at":{"type":"string","uniqueKey":"data.source_metadata.provider_config.twitter.crc_verified_at","typeLabel":"string"}},"type":"object","uniqueKey":"data.source_metadata.provider_config.twitter","typeLabel":"object"}},"type":"object","uniqueKey":"data.source_metadata.provider_config","typeLabel":"object"},"pub_sub":{"properties":{"amqp":{"properties":{"host":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.amqp.host","typeLabel":"string"},"auth":{"properties":{"password":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.amqp.auth.password","typeLabel":"string"},"user":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.amqp.auth.user","typeLabel":"string"}},"type":"object","uniqueKey":"data.source_metadata.pub_sub.amqp.auth","typeLabel":"object"},"bindedExchange":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.amqp.bindedExchange","typeLabel":"string"},"deadLetterExchange":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.amqp.deadLetterExchange","typeLabel":"string"},"port":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.amqp.port","typeLabel":"string"},"queue":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.amqp.queue","typeLabel":"string"},"routingKey":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.amqp.routingKey","typeLabel":"string"},"schema":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.amqp.schema","typeLabel":"string"},"vhost":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.amqp.vhost","typeLabel":"string"}},"type":"object","uniqueKey":"data.source_metadata.pub_sub.amqp","typeLabel":"object"},"google":{"properties":{"project_id":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.google.project_id","typeLabel":"string"},"service_account":{"items":{"type":"integer","uniqueKey":"data.source_metadata.pub_sub.google.service_account.items.[INDEX]","typeLabel":"integer"},"type":"array","uniqueKey":"data.source_metadata.pub_sub.google.service_account","typeLabel":"integer[]"},"subscription_id":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.google.subscription_id","typeLabel":"string"}},"type":"object","uniqueKey":"data.source_metadata.pub_sub.google","typeLabel":"object"},"kafka":{"properties":{"auth":{"properties":{"hash":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.kafka.auth.hash","typeLabel":"string"},"password":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.kafka.auth.password","typeLabel":"string"},"tls":{"type":"boolean","uniqueKey":"data.source_metadata.pub_sub.kafka.auth.tls","typeLabel":"boolean"},"type":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.kafka.auth.type","typeLabel":"string"},"username":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.kafka.auth.username","typeLabel":"string"}},"type":"object","uniqueKey":"data.source_metadata.pub_sub.kafka.auth","typeLabel":"object"},"brokers":{"items":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.kafka.brokers.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"data.source_metadata.pub_sub.kafka.brokers","typeLabel":"string[]"},"consumer_group_id":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.kafka.consumer_group_id","typeLabel":"string"},"topic_name":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.kafka.topic_name","typeLabel":"string"}},"type":"object","uniqueKey":"data.source_metadata.pub_sub.kafka","typeLabel":"object"},"sqs":{"properties":{"access_key_id":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.sqs.access_key_id","typeLabel":"string"},"default_region":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.sqs.default_region","typeLabel":"string"},"endpoint":{"description":"Optional: for LocalStack testing","type":"string","uniqueKey":"data.source_metadata.pub_sub.sqs.endpoint","typeLabel":"string"},"queue_name":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.sqs.queue_name","typeLabel":"string"},"secret_key":{"type":"string","uniqueKey":"data.source_metadata.pub_sub.sqs.secret_key","typeLabel":"string"}},"type":"object","uniqueKey":"data.source_metadata.pub_sub.sqs","typeLabel":"object"},"type":{"enum":["sqs","google","kafka","amqp"],"type":"string","x-enum-varnames":["SqsPubSub","GooglePubSub","KafkaPubSub","AmqpPubSub"],"uniqueKey":"data.source_metadata.pub_sub.type","typeLabel":"enum\u003cstring>"},"workers":{"type":"integer","uniqueKey":"data.source_metadata.pub_sub.workers","typeLabel":"integer"}},"type":"object","uniqueKey":"data.source_metadata.pub_sub","typeLabel":"object"},"type":{"enum":["http","rest_api","pub_sub","db_change_stream"],"type":"string","x-enum-varnames":["HTTPSource","RestApiSource","PubSubSource","DBChangeStream"],"uniqueKey":"data.source_metadata.type","typeLabel":"enum\u003cstring>"},"uid":{"type":"string","uniqueKey":"data.source_metadata.uid","typeLabel":"string"},"updated_at":{"type":"string","uniqueKey":"data.source_metadata.updated_at","typeLabel":"string"},"url":{"type":"string","uniqueKey":"data.source_metadata.url","typeLabel":"string"},"verifier":{"properties":{"api_key":{"properties":{"header_name":{"type":"string","uniqueKey":"data.source_metadata.verifier.api_key.header_name","typeLabel":"string"},"header_value":{"type":"string","uniqueKey":"data.source_metadata.verifier.api_key.header_value","typeLabel":"string"}},"type":"object","uniqueKey":"data.source_metadata.verifier.api_key","typeLabel":"object"},"basic_auth":{"properties":{"password":{"type":"string","uniqueKey":"data.source_metadata.verifier.basic_auth.password","typeLabel":"string"},"username":{"type":"string","uniqueKey":"data.source_metadata.verifier.basic_auth.username","typeLabel":"string"}},"type":"object","uniqueKey":"data.source_metadata.verifier.basic_auth","typeLabel":"object"},"hmac":{"properties":{"encoding":{"enum":["base64","hex"],"type":"string","x-enum-varnames":["Base64Encoding","HexEncoding"],"uniqueKey":"data.source_metadata.verifier.hmac.encoding","typeLabel":"enum\u003cstring>"},"hash":{"type":"string","uniqueKey":"data.source_metadata.verifier.hmac.hash","typeLabel":"string"},"header":{"type":"string","uniqueKey":"data.source_metadata.verifier.hmac.header","typeLabel":"string"},"secret":{"type":"string","uniqueKey":"data.source_metadata.verifier.hmac.secret","typeLabel":"string"}},"type":"object","uniqueKey":"data.source_metadata.verifier.hmac","typeLabel":"object"},"type":{"enum":["noop","hmac","basic_auth","api_key"],"type":"string","x-enum-varnames":["NoopVerifier","HMacVerifier","BasicAuthVerifier","APIKeyVerifier"],"uniqueKey":"data.source_metadata.verifier.type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"data.source_metadata.verifier","typeLabel":"object"}},"type":"object","uniqueKey":"data.source_metadata","typeLabel":"object"},"status":{"enum":["Processing","Failure","Success","Retry","Pending"],"type":"string","x-enum-varnames":["ProcessingStatus","FailureStatus","SuccessStatus","RetryStatus","PendingStatus"],"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"uid":{"type":"string","uniqueKey":"data.uid","typeLabel":"string"},"updated_at":{"type":"string","uniqueKey":"data.updated_at","typeLabel":"string"},"url_path":{"type":"string","uniqueKey":"data.url_path","typeLabel":"string"},"url_query_params":{"type":"string","uniqueKey":"data.url_query_params","typeLabel":"string"}},"type":"object","uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","status":true,"data":{"acknowledged_at":"\u003cstring>","app_id":"\u003cstring>","created_at":"\u003cstring>","data":[123],"deleted_at":"\u003cstring>","endpoint_metadata":[{"advanced_signatures":true,"authentication":{"api_key":{"header_name":"\u003cstring>","header_value":"\u003cstring>"},"basic_auth":{"password":"\u003cstring>","username":"\u003cstring>"},"oauth2":{"audience":"\u003cstring>","authentication_type":"shared_secret","client_id":"\u003cstring>","client_secret":"\u003cstring>","expiry_time_unit":"seconds","field_mapping":{"access_token":"\u003cstring>","expires_in":"\u003cstring>","token_type":"\u003cstring>"},"grant_type":"\u003cstring>","issuer":"\u003cstring>","scope":"\u003cstring>","signing_algorithm":"\u003cstring>","signing_key":{"crv":"\u003cstring>","d":"\u003cstring>","dp":"\u003cstring>","dq":"\u003cstring>","e":"\u003cstring>","kid":"\u003cstring>","kty":"\u003cstring>","n":"\u003cstring>","p":"\u003cstring>","q":"\u003cstring>","qi":"\u003cstring>","x":"\u003cstring>","y":"\u003cstring>"},"subject":"\u003cstring>","url":"\u003cstring>"},"type":"api_key"},"cb_state":"\u003cstring>","content_type":"\u003cstring>","created_at":"\u003cstring>","deleted_at":"\u003cstring>","description":"\u003cstring>","events":123,"failure_count":123,"failure_rate":123,"http_timeout":123,"mtls_client_cert":{"client_cert":"\u003cstring>","client_key":"\u003cstring>"},"name":"\u003cstring>","owner_id":"\u003cstring>","period_failure_rate":123,"project_id":"\u003cstring>","rate_limit":123,"rate_limit_duration":123,"retry_count":123,"secrets":[{"created_at":"\u003cstring>","deleted_at":"\u003cstring>","expires_at":"\u003cstring>","uid":"\u003cstring>","updated_at":"\u003cstring>","value":"\u003cstring>"}],"slack_webhook_url":"\u003cstring>","status":"active","success_count":123,"support_email":"\u003cstring>","uid":"\u003cstring>","updated_at":"\u003cstring>","url":"\u003cstring>"}],"endpoints":["\u003cstring>"],"event_type":"\u003cstring>","headers":{},"idempotency_key":"\u003cstring>","is_duplicate_event":true,"metadata":"\u003cstring>","project_id":"\u003cstring>","raw":"\u003cstring>","source_id":"\u003cstring>","source_metadata":{"body_function":"\u003cstring>","created_at":"\u003cstring>","custom_response":{"body":"\u003cstring>","content_type":"\u003cstring>"},"deleted_at":"\u003cstring>","event_type_location":"\u003cstring>","forward_headers":["\u003cstring>"],"header_function":"\u003cstring>","idempotency_keys":["\u003cstring>"],"is_disabled":true,"mask_id":"\u003cstring>","name":"\u003cstring>","project_id":"\u003cstring>","provider":"github","provider_config":{"twitter":{"crc_verified_at":"\u003cstring>"}},"pub_sub":{"amqp":{"host":"\u003cstring>","auth":{"password":"\u003cstring>","user":"\u003cstring>"},"bindedExchange":"\u003cstring>","deadLetterExchange":"\u003cstring>","port":"\u003cstring>","queue":"\u003cstring>","routingKey":"\u003cstring>","schema":"\u003cstring>","vhost":"\u003cstring>"},"google":{"project_id":"\u003cstring>","service_account":[123],"subscription_id":"\u003cstring>"},"kafka":{"auth":{"hash":"\u003cstring>","password":"\u003cstring>","tls":true,"type":"\u003cstring>","username":"\u003cstring>"},"brokers":["\u003cstring>"],"consumer_group_id":"\u003cstring>","topic_name":"\u003cstring>"},"sqs":{"access_key_id":"\u003cstring>","default_region":"\u003cstring>","endpoint":"\u003cstring>","queue_name":"\u003cstring>","secret_key":"\u003cstring>"},"type":"sqs","workers":123},"type":"http","uid":"\u003cstring>","updated_at":"\u003cstring>","url":"\u003cstring>","verifier":{"api_key":{"header_name":"\u003cstring>","header_value":"\u003cstring>"},"basic_auth":{"password":"\u003cstring>","username":"\u003cstring>"},"hmac":{"encoding":"base64","hash":"\u003cstring>","header":"\u003cstring>","secret":"\u003cstring>"},"type":"noop"}},"status":"Processing","uid":"\u003cstring>","updated_at":"\u003cstring>","url_path":"\u003cstring>","url_query_params":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Created","exampleType":"generated"},"a0dad010-442b-4184-aef6-6409aed490b1":{"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"status":{"type":"boolean","uniqueKey":"status","typeLabel":"boolean"},"data":{"type":"object","uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","status":true,"data":{}}}},"exampleType":"generated"}},"description":"Bad Request","exampleType":"generated"},"67e0f85e-bdf0-4b6b-a44d-f5bb6c73324b":{"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"status":{"type":"boolean","uniqueKey":"status","typeLabel":"boolean"},"data":{"type":"object","uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","status":true,"data":{}}}},"exampleType":"generated"}},"description":"Unauthorized","exampleType":"generated"},"9908f30c-c4fd-4f92-8a0b-6e84c991b337":{"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"status":{"type":"boolean","uniqueKey":"status","typeLabel":"boolean"},"data":{"type":"object","uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","status":true,"data":{}}}},"exampleType":"generated"}},"description":"Not Found","exampleType":"generated"}},"security":{"618666f8-b294-47b6-b7ea-b484e8a0db4d":{"ApiKeyAuth":{"in":"header","name":"Authorization","type":"apiKey","scopes":[]}}},"servers":{"ea05ed13-6fe8-4fcf-a55a-7dd4fbef101c":{"url":"https://us.getconvoy.cloud/api","description":"US Region"},"88107b80-52be-4d32-be46-16468ea6dbc5":{"url":"https://eu.getconvoy.cloud/api","description":"EU Region"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"in":"header","name":"Authorization","type":"apiKey","scopes":[]},"schema":{"title":"Authorization","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.yml"},"subdomain":"convoy","siteName":"Convoy","title":"Create a broadcast event - Convoy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-27T10:00:26.840Z","originalFileLocation":"api-reference/events/create-a-broadcast-event.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Convoy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a broadcast event - Convoy\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Convoy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.getconvoy.io/docs/api-reference/events/create-a-broadcast-event\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://convoy.mintlify.app/_mintlify/api/og/v2?division=Events\u0026amp;title=Create+a+broadcast+event\u0026amp;description=This+endpoint+creates+a+event+that+is+broadcast+to+every+endpoint+whose+subscription+matches+the+given+event+type.\u0026amp;theme=c3e2637d3c607fb0b7840509\u0026amp;signature=9c0b51e1526f791d90b13e07f82e14ccc63e5d521bd92e5b3f11d82f65fab5f8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a broadcast event - Convoy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://convoy.mintlify.app/_mintlify/api/og/v2?division=Events\u0026amp;title=Create+a+broadcast+event\u0026amp;description=This+endpoint+creates+a+event+that+is+broadcast+to+every+endpoint+whose+subscription+matches+the+given+event+type.\u0026amp;theme=c3e2637d3c607fb0b7840509\u0026amp;signature=9c0b51e1526f791d90b13e07f82e14ccc63e5d521bd92e5b3f11d82f65fab5f8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Convoy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2780F1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.getconvoy.io/docs/api-reference/events/create-a-broadcast-event\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/events/create-a-broadcast-event.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.getconvoy.io/#organization\",\"name\":\"Convoy\",\"url\":\"https://www.getconvoy.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/convoy/ZDnFuM112cm76jYI/logo/light.svg?fit=max\u0026auto=format\u0026n=ZDnFuM112cm76jYI\u0026q=85\u0026s=3d933080cf301678d7fafe5f50d4ec12\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.getconvoy.io/docs#website\",\"name\":\"Convoy\",\"url\":\"https://www.getconvoy.io/docs\",\"publisher\":{\"@id\":\"https://www.getconvoy.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.getconvoy.io/docs/api-reference/events/create-a-broadcast-event#webpage\",\"url\":\"https://www.getconvoy.io/docs/api-reference/events/create-a-broadcast-event\",\"name\":\"Create a broadcast event\",\"description\":\"This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type.\",\"dateModified\":\"2026-08-27T10:00:26.840Z\",\"isPartOf\":{\"@id\":\"https://www.getconvoy.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.getconvoy.io/docs/api-reference/events/create-a-broadcast-event#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.getconvoy.io/docs/api-reference/events/create-a-broadcast-event#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Events\",\"item\":\"https://www.getconvoy.io/docs/api-reference/events/list-all-events\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a broadcast event\",\"item\":\"https://www.getconvoy.io/docs/api-reference/events/create-a-broadcast-event\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.getconvoy.io/docs/api-reference/events/create-a-broadcast-event#apireference\",\"headline\":\"Create a broadcast event\",\"name\":\"Create a broadcast event\",\"description\":\"This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type.\",\"url\":\"https://www.getconvoy.io/docs/api-reference/events/create-a-broadcast-event\",\"mainEntityOfPage\":{\"@id\":\"https://www.getconvoy.io/docs/api-reference/events/create-a-broadcast-event#webpage\"},\"dateModified\":\"2026-08-27T10:00:26.840Z\",\"publisher\":{\"@id\":\"https://www.getconvoy.io/#organization\"},\"isPartOf\":{\"@id\":\"https://www.getconvoy.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Convoy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Convoy","nav":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://convoy-community.slack.com/join/shared_invite/zt-xiuuoj0m-yPp~ylfYMCV9s038QL0IUQ#/shared-invite/email"},{"anchor":"GitHub","icon":"github","href":"https://github.com/frain-dev/convoy"},{"anchor":"Status","icon":"signal","href":"https://status.getconvoy.io"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/home/quickstart"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"Welcome","href":"/api-reference/welcome"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Versioning","href":"/api-reference/versioning"}]},{"group":"Projects","pages":[{"openapi":"get /v1/projects","title":"List all projects","href":"/api-reference/projects/list-all-projects"},{"openapi":"post /v1/projects","title":"Create a project","href":"/api-reference/projects/create-a-project"},{"openapi":"get /v1/projects/{projectID}","title":"Retrieve a project","href":"/api-reference/projects/retrieve-a-project"},{"openapi":"put /v1/projects/{projectID}","title":"Update a project","href":"/api-reference/projects/update-a-project"},{"openapi":"delete /v1/projects/{projectID}","title":"Delete a project","href":"/api-reference/projects/delete-a-project"}]},{"group":"Endpoints","pages":[{"openapi":"get /v1/projects/{projectID}/endpoints","title":"List all endpoints","href":"/api-reference/endpoints/list-all-endpoints"},{"openapi":"post /v1/projects/{projectID}/endpoints","title":"Create an endpoint","href":"/api-reference/endpoints/create-an-endpoint"},{"openapi":"get /v1/projects/{projectID}/endpoints/{endpointID}","title":"Retrieve endpoint","href":"/api-reference/endpoints/retrieve-endpoint"},{"openapi":"put /v1/projects/{projectID}/endpoints/{endpointID}","title":"Update an endpoint","href":"/api-reference/endpoints/update-an-endpoint"},{"openapi":"delete /v1/projects/{projectID}/endpoints/{endpointID}","title":"Delete endpoint","href":"/api-reference/endpoints/delete-endpoint"},{"openapi":"put /v1/projects/{projectID}/endpoints/{endpointID}/expire_secret","title":"Roll endpoint secret","href":"/api-reference/endpoints/roll-endpoint-secret"},{"openapi":"put /v1/projects/{projectID}/endpoints/{endpointID}/pause","title":"Pause endpoint","href":"/api-reference/endpoints/pause-endpoint"},{"openapi":"post /v1/projects/{projectID}/endpoints/{endpointID}/activate","title":"Activate endpoint","href":"/api-reference/endpoints/activate-endpoint"},{"openapi":"post /v1/projects/{projectID}/endpoints/oauth2/test","title":"Test OAuth2 connection","href":"/api-reference/endpoints/test-oauth2-connection"}]},{"group":"Onboard","pages":[{"openapi":"post /v1/projects/{projectID}/onboard","title":"Bulk onboard endpoints with subscriptions","href":"/api-reference/onboard/bulk-onboard"}]},{"group":"Event Deliveries","pages":[{"openapi":"get /v1/projects/{projectID}/eventdeliveries","title":"List all event deliveries","href":"/api-reference/event-deliveries/list-all-event-deliveries"},{"openapi":"post /v1/projects/{projectID}/eventdeliveries/batchretry","title":"Batch retry event delivery","href":"/api-reference/event-deliveries/batch-retry-event-delivery"},{"openapi":"post /v1/projects/{projectID}/eventdeliveries/forceresend","title":"Force retry event delivery","href":"/api-reference/event-deliveries/force-retry-event-delivery"},{"openapi":"get /v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}","title":"Retrieve an event delivery","href":"/api-reference/event-deliveries/retrieve-an-event-delivery"},{"openapi":"put /v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/resend","title":"Retry event delivery","href":"/api-reference/event-deliveries/retry-event-delivery"}]},{"group":"Event Types","pages":[{"openapi":"post /v1/projects/{projectID}/event-types","title":"Create an event type","href":"/api-reference/event-types/create-an-event-type"},{"openapi":"put /v1/projects/{projectID}/event-types/{eventTypeId}","title":"Updates an event type","href":"/api-reference/event-types/update-an-event-type"},{"openapi":"post /v1/projects/{projectID}/event-types/{eventTypeId}/deprecate","title":"Deprecates an event type","href":"/api-reference/event-types/deprecate-an-event-type"},{"openapi":"post /v1/projects/{projectID}/event-types/import","title":"Import event types from OpenAPI spec","href":"/api-reference/event-types/import-event-types"},{"openapi":"get /v1/projects/{projectID}/event-types","title":"Retrieves a project's event types","href":"/api-reference/event-types/list-event-types"}]},{"group":"Delivery Attempts","pages":[{"openapi":"get /v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts","title":"List delivery attempts","href":"/api-reference/delivery-attempts/list-delivery-attempts"},{"openapi":"get /v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts/{deliveryAttemptID}","title":"Retrieve a delivery attempt","href":"/api-reference/delivery-attempts/retrieve-a-delivery-attempt"}]},{"group":"Events","pages":[{"openapi":"get /v1/projects/{projectID}/events","title":"List all events","href":"/api-reference/events/list-all-events"},{"openapi":"post /v1/projects/{projectID}/events","title":"Create an event","description":"This endpoint creates an endpoint event","href":"/api-reference/events/create-an-event"},{"openapi":"post /v1/projects/{projectID}/events/broadcast","title":"Create a broadcast event","href":"/api-reference/events/create-a-broadcast-event"},{"openapi":"post /v1/projects/{projectID}/events/batchreplay","title":"Batch replay events","description":"This endpoint replays multiple events at once.","href":"/api-reference/events/batch-replay-events"},{"openapi":"post /v1/projects/{projectID}/events/dynamic","title":"Dynamic Events","href":"/api-reference/events/dynamic-events"},{"openapi":"post /v1/projects/{projectID}/events/fanout","title":"Fan out an event","href":"/api-reference/events/fan-out-an-event"},{"openapi":"get /v1/projects/{projectID}/events/{eventID}","title":"Retrieve an event","href":"/api-reference/events/retrieve-an-event"},{"openapi":"put /v1/projects/{projectID}/events/{eventID}/replay","title":"Replay event","href":"/api-reference/events/replay-event"}]},{"group":"Meta Events","pages":[{"openapi":"get /v1/projects/{projectID}/meta-events","title":"List all meta events","href":"/api-reference/meta-events/list-all-meta-events"},{"openapi":"get /v1/projects/{projectID}/meta-events/{metaEventID}","title":"Retrieve a meta event","href":"/api-reference/meta-events/retrieve-a-meta-event"},{"openapi":"put /v1/projects/{projectID}/meta-events/{metaEventID}/resend","title":"Retry meta event","href":"/api-reference/meta-events/retry-meta-event"}]},{"group":"Portal Links","pages":[{"openapi":"get /v1/projects/{projectID}/portal-links","title":"List all portal links","href":"/api-reference/portal-links/list-all-portal-links"},{"openapi":"post /v1/projects/{projectID}/portal-links","title":"Create a portal link","href":"/api-reference/portal-links/create-a-portal-link"},{"openapi":"get /v1/projects/{projectID}/portal-links/{portalLinkID}","title":"Retrieve a portal link","href":"/api-reference/portal-links/retrieve-a-portal-link"},{"openapi":"put /v1/projects/{projectID}/portal-links/{portalLinkID}","title":"Update a portal link","href":"/api-reference/portal-links/update-a-portal-link"},{"openapi":"put /v1/projects/{projectID}/portal-links/{portalLinkID}/revoke","title":"Revoke a portal link","href":"/api-reference/portal-links/revoke-a-portal-link"},{"openapi":"get /v1/projects/{projectID}/portal-links/{portalLinkID}/refresh_token","title":"Get a portal link auth token","href":"/api-reference/portal-links/refresh-portal-link-token"}]},{"group":"Sources","pages":[{"openapi":"get /v1/projects/{projectID}/sources","title":"List all sources","href":"/api-reference/sources/list-all-sources"},{"openapi":"post /v1/projects/{projectID}/sources","title":"Create a source","href":"/api-reference/sources/create-a-source"},{"openapi":"get /v1/projects/{projectID}/sources/{sourceID}","title":"Retrieve a source","href":"/api-reference/sources/retrieve-a-source"},{"openapi":"put /v1/projects/{projectID}/sources/{sourceID}","title":"Update a source","href":"/api-reference/sources/update-a-source"},{"openapi":"delete /v1/projects/{projectID}/sources/{sourceID}","title":"Delete a source","href":"/api-reference/sources/delete-a-source"},{"openapi":"post /v1/projects/{projectID}/sources/test_function","title":"Validate source function","href":"/api-reference/sources/validate-source-function"}]},{"group":"Subscriptions","pages":[{"openapi":"get /v1/projects/{projectID}/subscriptions","title":"List all subscriptions","href":"/api-reference/subscriptions/list-all-subscriptions"},{"openapi":"post /v1/projects/{projectID}/subscriptions","title":"Create a subscription","href":"/api-reference/subscriptions/create-a-subscription"},{"openapi":"post /v1/projects/{projectID}/subscriptions/test_filter","title":"Validate subscription filter","href":"/api-reference/subscriptions/validate-subscription-filter"},{"openapi":"post /v1/projects/{projectID}/subscriptions/test_function","title":"Test a subscription function","href":"/api-reference/subscriptions/test-a-subscription-function"},{"openapi":"get /v1/projects/{projectID}/subscriptions/{subscriptionID}","title":"Retrieve a subscription","href":"/api-reference/subscriptions/retrieve-a-subscription"},{"openapi":"put /v1/projects/{projectID}/subscriptions/{subscriptionID}","title":"Update a subscription","href":"/api-reference/subscriptions/update-a-subscription"},{"openapi":"delete /v1/projects/{projectID}/subscriptions/{subscriptionID}","title":"Delete subscription","href":"/api-reference/subscriptions/delete-subscription"}]},{"group":"Subscription Filters","pages":[{"openapi":"post /v1/projects/{projectID}/subscriptions/{subscriptionID}/filters","title":"Create a new filter","href":"/api-reference/filters/create-a-subscription-filter"},{"openapi":"post /v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/bulk","title":"Create multiple subscription filters","href":"/api-reference/filters/bulk-create-subscription-filters"},{"openapi":"put /v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/{filterID}","title":"Update a filter","href":"/api-reference/filters/update-a-subscription-filter"},{"openapi":"put /v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/bulk_update","title":"Update multiple subscription filters","href":"/api-reference/filters/bulk-update-subscription-filters"},{"openapi":"get /v1/projects/{projectID}/subscriptions/{subscriptionID}/filters","title":"List all filters","href":"/api-reference/filters/get-all-subscription-filters"},{"openapi":"get /v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/{filterID}","title":"Get a filter","href":"/api-reference/filters/get-one-subscription-filter"},{"openapi":"delete /v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/{filterID}","title":"Delete a filter","href":"/api-reference/filters/delete-a-subscription-filter"},{"openapi":"post /v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/test/{eventType}","title":"Test a filter","href":"/api-reference/filters/test-a-filter"}]}]},{"tab":"Webhook Guides","pages":[{"title":"Webhook Guides","href":"/webhook-guides/webhook-retries"}]}]},"basePath":"","title":"Create a broadcast event - Convoy","buildId":"dpl_GWQzn6k13MqphA3qck3hQKoQXDzM","deploymentId":"dpl_GWQzn6k13MqphA3qck3hQKoQXDzM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-vlKR2tYY.js","utils-DBDPZSWe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CxHK4zz2.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-27b98BOz.js","snippetPresets-DNnui32z.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-cDVS2zyo.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BEE-OyDQ.js","shallow-fqEMZOYR.js","getApiPlaygroundDisplay-BPut1_OB.js","CodeSnippet-h9vp8UTG.js","CodeSnippets-DoMjCW5Q.js","Page-BOWGOUSK.js","getPastedJson-C4r-hmQ_.js","icon-CCDahfhO.js","MethodPill-Dpq0JSrS.js","DuplicateIcon-BGPwFt-j.js","createIcon-DBULrQp7.js","DynamicMarkdown-B74atANy.js","SectionHeading-DZCpbSmT.js","axios-vUo_bRtp.js","Markdown-BwkgxkAH.js","clsx-CEIlvfOI.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-f6OgbvLC.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DvlTOml0.js"]}