Back

WhatConverts API Essential Guide

Aug 16, 20246 minute read

What type of API does WhatConverts provide?

Based on the search results provided, there is no specific information about what type of API WhatConverts uses. The search results discuss different types of APIs like REST, SOAP, GraphQL, and gRPC, but do not mention WhatConverts specifically.

To answer this question accurately, we would need to look at WhatConverts' official documentation or developer resources. Without that information, I cannot definitively state what type of API WhatConverts uses.

However, I can provide some general information about API types that may be helpful:

Common API Types

  1. REST (Representational State Transfer) APIs:

    • Very popular and widely used
    • Based on HTTP methods (GET, POST, PUT, DELETE, etc.)
    • Typically use JSON for data exchange
    • Stateless and follow a client-server model
  2. SOAP (Simple Object Access Protocol) APIs:

    • Use XML for message format
    • More rigid structure compared to REST
    • Often used in enterprise environments
    • Can be more complex to implement
  3. GraphQL APIs:

    • Query language for APIs
    • Allows clients to request specific data they need
    • Can be more efficient than REST for complex data requirements
    • Requires specialized server and client libraries
  4. gRPC (gRPC Remote Procedure Call) APIs:

    • Developed by Google
    • Uses Protocol Buffers for data serialization
    • Designed for high performance and low latency
    • Often used in microservices architectures

Key Points to Consider

  • Many modern web services tend to use REST APIs due to their simplicity and wide support.
  • Without specific information about WhatConverts, it's not possible to determine which type of API they use.
  • To find out, you would need to check WhatConverts' official documentation or contact their support team.

Does the WhatConverts API have webhooks?

Does WhatConverts have webhooks?

Yes, WhatConverts does offer webhooks functionality.

Types of events you can subscribe to

The search results mention the following webhook event types:

  1. Lead Types - You can select specific lead types when setting up a webhook.
  2. Trigger Type - You can select a trigger type for the webhook.
  3. Custom Events - There is mention of a "Custom Event" webhook, which allows sending custom event data.

Key points about WhatConverts webhooks:

  • You can set up webhooks through the WhatConverts Dashboard under Integrations > Webhooks.
  • You can add up to 5 webhooks that will trigger at one time.
  • When setting up a webhook, you need to provide:
    • Webhook URL
    • Lead Types
    • Trigger Type
  • For custom events, you can include additional fields like full name and email address.

API Access

The search results also mention that WhatConverts offers API access:

  • You can get an API key from the WhatConverts dashboard.
  • The API gives you access to data within your account.

Rate Limits and other limitations

Here are the key points regarding the API Rate Limits of the WhatConverts API:

Rate Limit

  • Your API key can be used to make up to 1 request every millisecond.

Request Limit

  • Profile API key: Up to 1,000 requests per day
  • Master account API key: Up to 10,000 requests per day

Key Considerations

  • The rate limits are different for profile API keys vs master account API keys.
  • There is both a rate limit (requests per millisecond) and a daily request limit.
  • Exceeding these limits may result in API errors or throttling.

Best Practices

  • Monitor your API usage to avoid exceeding rate limits.
  • Implement proper error handling for rate limit errors.
  • Use the master account API key if you need a higher daily request limit.
  • Consider caching API responses where possible to reduce the number of requests.

Additional Notes

  • Authentication is done via HTTP Basic auth using a token and secret.
  • The API documentation provides details on endpoints, data formats, and integration guidelines.
  • WhatConverts offers support resources including documentation, a support team, and community forums to assist with API integration.

By adhering to these rate limits and following best practices, you can effectively integrate the WhatConverts API into your applications while avoiding potential issues related to exceeding usage limits.

Latest API Version

Based on the search results provided, I could not find any specific information about the most recent version of the WhatConverts API. The search results contain general information about the WhatConverts API, but do not mention version numbers or recent updates.

Key points to consider:

  1. The WhatConverts API provides access to data within your account [1].

  2. Authentication for the API uses HTTP Basic authentication with a token and secret [1].

  3. The API documentation covers various endpoints including Accounts, Profiles, Users, Roles, Leads, Recordings, and Tracking [1].

  4. To access the API, you need to obtain an API Key from your WhatConverts dashboard [3].

Without more specific information about API versions, I cannot provide a definitive answer about the most recent version. If you need to know the current version of the API, I would recommend:

  1. Checking the official WhatConverts API documentation for any version information.
  2. Contacting WhatConverts support directly for the most up-to-date information on API versions.
  3. Looking for any changelog or release notes that might indicate recent updates or version changes.

If you're working with the WhatConverts API, it's best to use the most current documentation available on their website to ensure you're using the latest features and best practices.

How to get a WhatConverts developer account and API Keys?

To get a developer account for WhatConverts and create an API integration, you need to follow these steps:

  1. Sign up for a WhatConverts account if you don't already have one.

  2. Log into your WhatConverts dashboard.

  3. Navigate to an account (required for agency plans) and select a profile in your account. If you have only one profile, it will be automatically selected.

  4. Click on "Integrations" in the dashboard menu, then select "API Keys" from the dropdown.

  5. Click on "Create API Accounts" and select "Create V2/V3 API Token".

  6. Name your API account according to your requirements.

  7. Your API Token will be generated and appear on the page. Click the "lock" icon to reveal the API Secret.

  8. Copy both the API Token and API Secret. You'll need these to authenticate your requests to the WhatConverts API.

What can you do with the WhatConverts API?

Based on the information provided in the search results, here is a list of data models you can interact with using the WhatConverts API, along with what is possible for each:

Accounts

  • Retrieve accounts
  • Edit accounts
  • Add new accounts
  • Delete accounts

Profiles

  • Retrieve profiles
  • Edit profiles
  • Add new profiles
  • Delete profiles

Leads

  • Retrieve leads
  • Edit leads
  • Add new leads

Recordings

  • Retrieve recordings

Key Points for Each Data Model

  1. Accounts:

    • Manage multiple accounts within the WhatConverts system
    • Useful for agency plans or businesses with multiple entities
  2. Profiles:

    • Handle different profiles within accounts
    • Allows for segmentation of data within a single account
  3. Leads:

    • Access and manage lead information
    • Ability to add new leads programmatically
    • Edit existing lead data
  4. Recordings:

    • Retrieve call recordings associated with leads
    • Useful for quality assurance or further analysis

Additional API Features

  • Real-time data access for integrating with CRMs and call center management systems
  • Ability to trigger actions based on call events (initiation, start, completion)
  • Access to marketing source information for leads

API Usage Limits

  • Profile API key: 1,000 requests per day
  • Master account API key: 10,000 requests per day
  • Rate limit: 1 request per millisecond

Authentication

  • Uses HTTP Basic authentication with a token and secret

Best Practices

  • Use appropriate authentication for secure access to the API
  • Be mindful of the request limits to avoid exceeding quotas
  • Utilize real-time capabilities for immediate data processing when needed
  • Consider the specific data models required for your use case when integrating with the API