Skip to main content
POST
Register an installation

Authorizations

Authorization
string
header
required

Your project's publishable key (pk_pub_…). Safe to expose in the browser — it identifies the project and is rate-limited, not secret.

Body

application/json

Encoded JSON body limit: 262144 bytes (256 KiB), including JSON escapes and whitespace.

installationId
string
required
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
appId
string
required
Required string length: 1 - 256
platform
enum<string>
required
Available options:
ios,
android
environment
enum<string>
required
Available options:
development,
production
capability
string
required
Required string length: 43 - 128
Pattern: ^[A-Za-z0-9_-]{43,128}$

Response

Current installation state or replayed acknowledgement.

installation
object
required