# Installation details

# Introduction

The Installation API allows you to fetch complete details about your app's installation for a specific merchant. This includes app information, merchant details, granted permissions, custom inputs, and webhook configurations.

# Get Installation

To get the installation details, you will need to make an HTTP GET request to the following endpoint:

GET
https://api.armadadelivery.com/v1/installation

# Request Example

Remember to include your Armada-Access-Token in the request headers. If you don't have one, please refer to the Authentication page to learn how to obtain it.

cURL
curl --location --request GET 'https://api.armadadelivery.com/v1/installation' \
--header 'Armada-Access-Token: [YOUR ACCESS TOKEN]'

# Response Schema

{
  "installation_id": "String", // Unique installation identifier
  "installed_at": "ISO Date", // Installation timestamp
  "app": { // Your application information
    "id": "String", // App ID
    "name": "String" // App name
  },
  "merchant": { // Merchant who installed the app
    "id": "String", // Merchant unique identifier
    "name": "String", // Merchant business name
    "email": "String", // Merchant email address
    "country": "String" // Merchant country
  },
  "permissions": Array, // Array of granted permission strings
  "inputs": Array, // Array of custom input objects { name, value }
  "webhooks": Array // Array of webhook configurations
}

# Response Examples

{
  "installation_id": "efbf463b-c0cb-44d2-8278-1ac8e063d0d6",
  "installed_at": "2026-01-04T16:33:27.055Z",
  "app": {
    "id": "693b6631f90ca5761e6f76fe",
    "name": "Armada Start"
  },
  "merchant": {
    "id": "6823ba72ab71300031c72994",
    "name": "Zakaria-206742",
    "email": "Zakaria.206742@armadadev.com",
    "country": "Kuwait"
  },
  "permissions": [],
  "inputs": [],
  "webhooks": []
}

{
  "installation_id": "81dcc01a-193a-4530-94db-25b62a88c8e5",
  "installed_at": "2026-01-05T15:37:22.747Z",
  "app": {
    "id": "682c8673a129e54224fefaae",
    "name": "Belaban"
  },
  "merchant": {
    "id": "6823ba72ab71300031c72994",
    "name": "Zakaria-206742",
    "email": "Zakaria.206742@armadadev.com",
    "country": "Kuwait"
  },
  "permissions": [
    "branch:delete",
    "branch:read",
    "branch:update",
    "branch:write",
    "delivery:cancel",
    "delivery:read",
    "delivery:write",
    "wallet:read"
  ],
  "inputs": [
    {
      "name": "Ticker Number",
      "value": 123
    }
  ],
  "webhooks": [
    {
      "topic": "order.updated",
      "url": "https://yourwebsite.com/armada/webhooks?topic=order_updated"
    },
    {
      "topic": "order.location.updated",
      "url": "https://yourwebsite.com/armada/webhooks?topic=order_location_updated"
    },
    {
      "topic": "wallet.balance_low",
      "url": "https://yourwebsite.com/armada/webhooks?topic=wallet_balance_low"
    }
  ]
}

# Use Cases

Check if your app is properly installed and retrieve the installation ID for internal tracking.

Show merchants which permissions they've granted and what webhooks are configured.

Retrieve configured webhook URLs to verify they're pointing to the correct endpoints.

Check which permissions were granted during installation for compliance and feature availability.

Retrieve and validate custom inputs submitted during installation to ensure proper configuration.

Authentication - Learn about the installation flow and access tokens
App Creation - Configure permissions, inputs, and webhooks