App Installed

Sent BY Ewity TO your app's registered webhook endpoint(s). The
path on this page exists only for docs grouping — deliveries POST to
the endpoint URL(s) you registered. Identify the event by the
X-Ewity-Event header.

Fires when a business installs your app and approves its requested
role scopes. data.approved_roles is the list of role slugs the
merchant approved and data.scopes_version is the version of your
app's scope set they approved. Use it to provision the merchant on
your side; the install.store_id in the envelope is the id your app
passes as X-Ewity-Store on Apps API calls for this business.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Unique delivery id.

string
enum
Allowed:
string

ISO-8601 timestamp the event was emitted.

company
object

The merchant business — {id, name, domain}.

install
object

The app install — {store_id, external_account_id}. store_id is the value your app sends as X-Ewity-Store.

data
object

{approved_roles: string[], scopes_version: integer} — the role slugs the merchant approved and the scope-set version they belong to.

Headers
string
enum
required

Always app.installed for this event.

Allowed:
string
required

Unique delivery id (same as the envelope id). Dedupe on it.

string

Present when the endpoint's verification mode is signature (the default). Format t=<unix>,v1=<hex hmac_sha256> — see the webhooks overview for verification. Endpoints in platform_key mode receive Authorization: Bearer <platform API key> instead.

Response
2XX

Receiver acknowledged. Any 2xx counts as successful delivery. Non-2xx and connection failures are logged but not retried — deliveries are best-effort single attempts.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here!