Skip to content
Stashtab Docs
Esc
↑↓navigate↵open⌘Jpreview

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.

POST/v1/organizations/{orgId}/partner-events/subscriptions
Authorization
AuthorizationBasic auth · headerrequired

Registered confidential integration credentials. Keep the secret server-side.

or
CookieAPI key · headerrequired

Console-managed Vault session cookie; secure cookie naming may vary by environment.

or
AuthorizationBearer token (Vault organization API key) · headerrequired

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

Path parameters
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Request body
requiredapplication/json
urlstring<uri>required
max length 2048
Responses
200

Success

dataobjectrequired
Show properties
subscriptionobjectrequired
Show properties
createdAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
revokedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
subscriptionIdstring<uuid>required
matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
urlstring<uri>required
max length 2048
metaobjectrequired
Show properties
requestIdstringrequired
default

Error

errorobjectrequired
Show properties
codestringrequired
Allowed:forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_ready
fieldsobject[]
Show properties
Array of object
codestringrequired
messagestringrequired
pathstringrequired
messagestringrequired
operationIdstring
metaobjectrequired
Show properties
requestIdstringrequired
Request
curl -X POST '/v1/organizations/org_example/partner-events/subscriptions' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://receiver.example/events"
}'
Response
{
  "data": {
    "subscription": {
      "createdAt": "2026-11-05T15:00:00.000Z",
      "revokedAt": null,
      "subscriptionId": "00000000-0000-4000-8000-000000000010",
      "url": "https://receiver.example/events"
    }
  },
  "meta": {
    "requestId": "example-createPartnerEventSubscription"
  }
}

Was this page helpful?