Skip to main content

1. Obtain an API key

Sign in to your partner workspace and open Partner platforms → Developers. Generate a key with obligations:write, obligations:read, events:read, and webhooks:manage. If you do not have partner access yet, ask Already to add you. The secret is displayed once. Store it on your server or in a secret manager; it must never be embedded in browser code.

2. Submit an obligation

Set ALREADY_API_BASE_URL to the development API URL supplied by Already. Use a unique Idempotency-Key for each new submission. This example uses placeholder parties and dates; choose a future due date in your test environment.
The response contains a submission with status received. Submission is not an offer. An Already operator reviews it, chooses funded capacity, and publishes an offer if approved. See submission rules.

3. Register and test your webhook

Register a public HTTPS callback in Partner platforms → Developers or with POST /partner/v1/webhooks. Save the one-time signing secret and verify every delivery. Send a test event, then confirm an integration.test event reaches your receiver. See webhooks.

4. Follow the offer

Listen for submission.approved, obligation.created, and offer.available. You can also poll the event cursor after an outage. Once the business accepts, subsequent events track acceptance, payout, and repayment.