Developer

Generate and manage API keys for seamless integration and secure access to the platform’s services.

API Key Generator

The "Developer" section, accessible under "My Profile," allows users to generate API keys. API keys are essential for integrating with our platform, as they provide a secure method to authenticate and authorize API requests. These keys also help manage usage, track activity, and prevent unauthorized access to the system. Once generated, users can copy the key for immediate use in their integration processes. For more details on how to use API keys with our services, users can refer to the API documentation linked on the page.


Webhooks

Webhooks allow your system to receive real-time updates on the status of recovery attempts without polling the API. You can configure webhook endpoints to receive lifecycle events triggered during the recovery process.


Configuring Webhook Endpoints

To start receiving webhook notifications:

  • Navigate to Developer > Webhooks in the Sticky Recovery dashboard.
  • Add the destination URL(s) for your webhook receiver.
  • Select the event types you wish to subscribe to.
  • Each event will POST a JSON payload to your URL.

Supported Webhook Events

Event TypeDescription
recovery_startedFired when a recovery session is successfully created.
recovery_attempt_failedTriggered after a retry attempt fails.
recovery_successfulTriggered when a retry attempt results in a successful payment.
recovery_unsuccessfulFired when a session ends without recovery (max retries reached or canceled).