Ensure an inbox exists
Idempotently ensure an inbox exists for the provided key. Returns the existing inbox if one with the same key and matching configuration already exists, or creates a new one. name remains accepted as a deprecated alias for key. Returns 409 if an inbox with the same key but different configuration exists.
Authorizations
OAuth 2.0 authentication.
Headers
Optional UUID identifying the event or action that caused this request.
Optional UUID to trace this request through downstream systems.
Body
Request to idempotently ensure an inbox exists. A key is required
(name is accepted as a deprecated alias).
Trigger subscription configuration for an inbox.
The inbox's natural key. Set at creation, immutable, unique per user.
100Deprecated alias for key. Use key instead.
100The reason the inbox was paused, if applicable.
user- userauthentication- authenticationauthentication_access_revoked- authentication_access_revokedpartner_revoked- partner_revokedsubscribe_failed- subscribe_failedmigrate_failed- migrate_failedabandoned- abandonedunknown- unknownupstream_failures- upstream_failures
user, authentication, authentication_access_revoked, partner_revoked, subscribe_failed, migrate_failed, abandoned, unknown, upstream_failures URL to POST notifications to when messages become available.
2048Response
An inbox: a durable, user-scoped queue for a trigger subscription,
identified by its natural key.
An inbox: a durable, user-scoped queue for a trigger subscription,
identified by its natural key.
The unique identifier for the inbox.
Creation timestamp in ISO 8601 format.
The status of the inbox.
Trigger subscription configuration for an inbox.
The inbox's natural key. Set at creation, immutable, unique per user.
100Deprecated alias for key. Use key instead.
100The reason the inbox was paused, if applicable.
user- userauthentication- authenticationauthentication_access_revoked- authentication_access_revokedpartner_revoked- partner_revokedsubscribe_failed- subscribe_failedmigrate_failed- migrate_failedabandoned- abandonedunknown- unknownupstream_failures- upstream_failures
user, authentication, authentication_access_revoked, partner_revoked, subscribe_failed, migrate_failed, abandoned, unknown, upstream_failures URL to POST notifications to when messages become available.
2048