Create a partner event subscription
Register a receiver URL for this organization and immutable mode. The request contains only url; delivery configuration and signing material remain private. Configured Test delivery records a capture without contacting the receiver or using a Live signing key. Delivery supports public HTTPS on port 443, rechecks resolved addresses and does not follow redirects. Repeating the exact active URL with the same configured binding returns its existing subscription; another binding conflicts. The HTTP response is data.subscription with subscriptionId, url, createdAt and revokedAt. A null revokedAt means active. Creation requires current delivery configuration and does not establish a business event, successful receiver delivery or provider acceptance.
/v1/organizations/{orgId}/partner-events/subscriptionsAuthorizationBasic auth · headerrequiredRegistered confidential integration credentials. Keep the secret server-side.
CookieAPI key · headerrequiredConsole-managed Vault session cookie; secure cookie naming may vary by environment.
AuthorizationBearer token (Vault organization API key) · headerrequiredOrganization-owned credential with immutable mode and Read-only or Read/write permissions. Only explicitly declared ordinary customer operations accept it. Test business access refuses until shared Test composition is available; no staff, team, key-management or protocol authority is granted.
orgIdstringrequiredapplication/jsonurlstring<uri>requiredSuccess
dataobjectrequiredShow propertiesHide properties
subscriptionobjectrequiredShow propertiesHide properties
createdAtstring<date-time>requiredrevokedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullsubscriptionIdstring<uuid>requiredurlstring<uri>requiredmetaobjectrequiredShow propertiesHide properties
requestIdstringrequiredError
errorobjectrequiredShow propertiesHide properties
codestringrequiredforbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_readyfieldsobject[]Show propertiesHide properties
objectcodestringrequiredmessagestringrequiredpathstringrequiredmessagestringrequiredoperationIdstringmetaobjectrequiredShow propertiesHide properties
requestIdstringrequired