Guide
API & Webhooks

API & Webhooks

What is it?

API & Webhooks help you connect Flinkk One with external applications. The API lets you access and manage your CRM data programmatically, while webhooks send real-time notifications when events happen in your system.

Why use API & Webhooks?

  • Integrate External Tools - Connect Flinkk One with Zapier, Make, or custom applications
  • Automate Workflows - Trigger actions automatically when events occur
  • Access CRM Data - Read and manage leads, contacts, opportunities, and more programmatically
  • Real-time Notifications - Get instant updates when records are created, updated, or deleted

API Keys

What are API Keys?

API Keys are authentication tokens that allow secure access to your Flinkk One data. Think of them as passwords for applications - they grant permissions to read or modify specific data.

How to Create an API Key

  1. Go to Admin CenterDeveloper ToolsAPI Keys
  2. Click New API Key
  3. Give your key a name (e.g., "Zapier Integration")
  4. Click Create
  5. Copy the key immediately - it's only shown once for security

How to Use API Keys

Include your API key in requests:

Authorization: Bearer YOUR_API_KEY

API Key Best Practices

  • Keep keys secure - never share or publish them
  • Use separate keys for different applications
  • Rotate keys periodically for security
  • Delete unused keys

Webhooks

What are Webhooks?

Webhooks are URLs where Flinkk One sends automatic notifications when something happens. For example, when a lead is created, your webhook receives that information instantly.

How to Create a Webhook

  1. Go to Admin CenterDeveloper ToolsWebhooks
  2. Click Create Webhook
  3. Enter webhook details:
    • Name: A descriptive name for your webhook
    • URL: Where to send notifications
    • Events: Select which events to listen for
  4. Click Create

Webhook Configuration

Available Events

You can subscribe to events from:

  • CRM - Leads (8 events)
  • CRM - Opportunities (9 events)
  • CRM - Contacts (5 events)
  • CRM - Companies (4 events)
  • CRM - Tasks (8 events)
  • Support - Tickets (11 events)
  • Sales - Quotes (7 events)
  • Sales - Products (5 events)
  • System Events (9 events)

How Webhooks Work

  1. An event happens in Flinkk One
  2. Flinkk One sends an HTTP POST request to your webhook URL
  3. Your application receives and processes the data
  4. You send back a success response

Webhook Flow

Webhook Security

Each webhook has a secret key that signs requests. Always verify the signature to ensure requests come from Flinkk One.

Webhook Retries

If your webhook doesn't respond, Flinkk One retries automatically:

  • 1st: Immediate
  • 2nd: 5 minutes
  • 3rd: 30 minutes
  • 4th: 2 hours
  • 5th: 24 hours

After 5 attempts, the webhook is disabled.

Managing Webhooks

In Admin CenterDeveloper ToolsWebhooks, you can:

  • Enable or disable webhooks
  • Edit webhook settings
  • View delivery logs
  • Retry failed deliveries

Common Use Cases

Synchronize Data: Sync leads between Flinkk One and other tools

Automate Notifications: Send emails or Slack messages when new leads arrive

Create Forms: Build custom forms that create leads in Flinkk One

Trigger Actions: Automatically update records based on external events

Getting Started

  1. Create an API key in Developer Tools
  2. Set up your first webhook for important events
  3. Test your integration
  4. Monitor webhook logs and adjust as needed