Developer Settings
Manage API keys and configure webhooks to integrate Replyn with your external applications and services.
The Developer Settings section provides tools for integrating Replyn with external systems. Generate API keys for programmatic access, and configure webhooks to receive real-time notifications when events occur in your organization.
For detailed API endpoint documentation, request and response schemas, and code examples, visit the Replyn API Documentation. The Developer Settings page is where you manage the credentials needed to use the API.
API Keys
API keys allow external applications to authenticate with the Replyn API on behalf of your organization. Each key grants access to your organization's data, so they should be treated as sensitive credentials.
Creating an API Key
Navigate to Settings > Developer.
In the API Keys section, click Create API Key.
Enter a name for the key to identify its purpose (e.g., "Website Integration", "CRM Sync", "Zapier Connector").
Click Create. The API key will be displayed once. Copy it immediately and store it securely.
API keys are displayed only once at the time of creation. If you lose the key, you will need to revoke it and create a new one. Never share API keys in public repositories, client-side code, or unsecured channels.
Revoking an API Key
To revoke an API key:
- Navigate to Settings > Developer.
- Find the key in the API Keys list.
- Click the Revoke button next to the key.
- Confirm the revocation.
Revoked keys are immediately invalidated. Any application using the revoked key will lose access.
Webhook Configuration
Webhooks allow Replyn to send real-time HTTP POST requests to your server whenever specific events occur (e.g., a new contact is created, a conversation is opened, an order is placed).
Setting Up a Webhook
Navigate to Settings > Developer.
In the Webhooks section, click Add Webhook.
Enter the URL of the endpoint on your server that will receive webhook events.
Select the events you want to subscribe to (e.g., contact.created, conversation.opened, order.created).
Optionally, enter a secret that Replyn will use to sign webhook payloads, allowing your server to verify authenticity.
Click Save to activate the webhook.
Available Webhook Events
| Event | Description |
|---|---|
contact.created | A new contact is added to your CRM. |
contact.updated | A contact's details are modified. |
conversation.opened | A new conversation is started. |
conversation.closed | A conversation is marked as resolved. |
message.received | An inbound message is received from a contact. |
message.sent | An outbound message is sent to a contact. |
ticket.created | A new support ticket is created. |
ticket.resolved | A ticket is marked as resolved. |
order.created | A new order is placed (Ecommerce only). |
order.updated | An order's status changes (Ecommerce only). |
Testing Webhooks
After configuring a webhook, use the Send Test button to send a sample payload to your endpoint. This helps you verify that your server is correctly receiving and processing webhook events before relying on them in production.
If your webhook endpoint fails to respond with a 2xx status code, Replyn will retry the delivery up to 3 times with exponential backoff. Failed deliveries are logged in the webhook event history for troubleshooting.
