API Keys and Webhooks

If your company integrates Assin with other systems (ERP, CRM, website), use API keys to send and query envelopes and webhooks to receive automatic notices when something happens. Everything is under Integrations in the side menu, with the API Keys and Webhook options.

Company only (PJ): This feature is not available on the individual account. See the difference in Using Assin as an individual.

The Integrations menu appears for companies with API access enabled on the plan, and the keys screen is restricted to company managers (see Collaborators and permissions). If you don’t see it, talk to Support or to your manager.

API Keys

1. Under Integrations > API Keys, the list shows the Name, the Public Key, the Status (Active or Inactive), the Created at and Updated at dates and the Actions. Inactive keys created more than 12 months ago get the notice “Old key: consider regenerating”.

List of the company API Keys

2. To create one, click “New API Key”. In the New API Key window, give it a name that identifies the integration (for example, “ERP Integration”) and click “Next”.

New API Key window

3. Assin shows the Public Key and the Secret Key, with buttons to copy them. The Secret Key is shown only once: copy and store both in a safe place before clicking “Close”. Whoever has the keys can access your company’s account.

4. Under Actions you can:

  • Activate key / Deactivate key: turns the key’s use on or off without deleting it.
  • Regenerate key: generates new credentials in place of the current ones, after a confirmation. The action cannot be undone and integrations using the old key must be updated.
  • Delete key: removes the key permanently. To confirm, type the key name in the Remove API Key window.

Best practices: create one key per integration, never share the key by e-mail or chat and deactivate those you no longer use. Requests are made through Assin’s public API (documentation available to your development team). When a new key is created, Assin also sends a notice e-mail (see E-mails sent by Assin).

Webhooks

A webhook is an address (URL) in your system that receives a notice from Assin when an event happens, for example, when an envelope is finalized.

5. Under Integrations > Webhook (the Event destinations screen), the list shows the Endpoint URL, the Description and the Actions (edit and delete).

List of webhook endpoints

6. Click “New endpoint”. In the Create new endpoint window, enter the Endpoint URL and a description (up to 200 characters) and click “Next”. The URL must be public and use HTTPS: it cannot be localhost, an internal network address or contain a username and password.

Create new endpoint window

7. Use the pencil (Edit endpoint) to change and the trash (Delete endpoint) to delete (the platform asks “Do you want to delete this endpoint?”). When you open an endpoint you also see the delivery history, with time and IP address.

Those who integrate through the public API can also choose the events of each webhook (envelope finished, envelope canceled, envelope expired and each signer’s signature), set custom headers (for example, for authentication) and reprocess failed deliveries.

Points of attention:

  • Your server must respond with success (a 2xx code) within 10 seconds and handle the same event safely in case it arrives more than once (idempotency).
  • If your system is down, Assin records the failure in the endpoint log but does not resend automatically. To resend failed deliveries, use the public API reprocessing.

For more information visit our website https://assin.com.br/

See how simple it is, Assin?

Assin Digital Signature

Was this article helpful?

Didn't find what you were looking for?

Our team answers Monday to Friday, during business hours. Count on us.