Integration Guide

How extensions integrate with Angage

Overview

Angage extensions integrate with the platform directly via REST API and webhooks. There is currently no client-side JavaScript SDK or App Bridge library provided. Extensions are independent web services that the ERP communicates with through well-defined HTTP contracts.

Integration Components

An integration is made up of three things:

  • Manifest — declares your extension's identity, required scopes, UI extensions, hooks, and webhook subscriptions.
  • Webhook Endpoints — HTTP endpoints on your service that receive events from Angage. Webhook payloads are signed and your service must verify the signature.
  • API Access — your extension queries Angage data via the platform API by sending the X-Platform-Api-Key header.

Development Approach

To build an extension you should stand up a web service that:

  • Hosts a manifest.json at a public HTTPS URL.
  • Implements webhook receivers, including signature verification, for the events declared in your manifest.
  • Queries the Angage marketplace API for tenant-specific data using your platform API key.

UI Extensions

Extensions can render UI inside Angage by declaring entries in ui_extensions in the manifest. The iframe type loads a URL from your service inside Angage at the declared location (for example, invoice.sidebar or dashboard.widget). Your iframe page is a normal web page hosted by your extension service.

No Current SDK

A client-side JavaScript SDK (often called "App Bridge" in similar platforms) is not currently provided. Extensions must integrate directly via REST API calls and webhook handlers. A future release may include an SDK to simplify common patterns.

Next Steps