Organization → Business Apps

Register and manage partner integrations — the credentials a partner backend uses to dispatch workflows or embed vScrawl signing in another product. Full integration walkthrough: Partner & Iframe Embed.

Endpoint summary

Method	Path	Notes
GET	/organization/v1/apps	List apps (paginated, filters: clientId, appName, callBackUrl, status, searchValue)
GET	/organization/v1/apps/{clientId}	Get one app (secret not included)
POST	/organization/v1/apps	Register a new app
GET	/organization/v1/apps/{clientId}/secret	Rotate the client secret
PUT	/organization/v1/apps/{clientId}	Update
DELETE	/organization/v1/apps?clientIds=acme-crm	Delete one or more

Registering an app

POST /organization/v1/apps
Content-Type: application/json

{
  "clientId": "acme-crm",
  "appName": "Acme CRM Integration",
  "callbackUrl": "https://acme.example.com/vscrawl/callback",
  "status": true
}

Field	Validation
clientId	required, must start with a letter, then letters/digits/_/-
appName	required, same character family, spaces allowed
callbackUrl	required — where the embed hands control back after signing
status	required — true to enable immediately
webhookUrl, webhookEvents, webhookActive	optional — for server-side completion notifications alongside the iframe callback

Success (200 OK):

{ "clientSecret": "sk_live_9f8e7d6c5b4a..." }

The secret is shown once — store it securely. Rotate it later with GET /organization/v1/apps/{clientId}/secret.

Errors: clientId or appName already taken within the org.

Once registered, see Partner & Iframe Embed for how the partner actually uses this app: obtaining a token, dispatching workflows, and embedding the signing UI.