RD Station API Essential Guide

What type of API does RD Station provide?

Based on the search results provided, there is no specific information about the type of API used by RD Station. The search results contain general information about different API types like REST, SOAP, and GraphQL, but do not mention RD Station specifically.

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

However, I can provide some general information about common API types:

Key API Types

1. REST (Representational State Transfer)

   • Most common and widely used API type today
   • Uses standard HTTP methods (GET, POST, PUT, DELETE, etc.)
   • Typically returns data in JSON format
   • Stateless and scalable

2. SOAP (Simple Object Access Protocol)

   • Uses XML for message format
   • More rigid and formal than REST
   • Often used in enterprise environments
   • Good for scenarios requiring high security and complex transactions

3. GraphQL

   • Query language for APIs
   • Allows clients to request exactly the data they need
   • Single endpoint for all data queries
   • Flexible and efficient for complex data structures

Considerations

• Without specific information about RD Station, it's most likely that they use a REST API, as it's the most common type for modern web services.
• To confirm the API type, you would need to check RD Station's official API documentation or developer resources.
• If you're planning to integrate with RD Station, contacting their support or developer relations team would be the best way to get accurate information about their API.

Does the RD Station API have webhooks?

Webhooks Support

Yes, the official RD Station API does support webhooks.

Types of Events

The RD Station API allows you to subscribe to various types of events through webhooks. Some of the event types you can subscribe to include:

1. Conversion events
2. Opportunity events (when a lead is marked as an opportunity)
3. Chat events
4. Media events (e.g., start and end of media playback)
5. E-commerce events
6. Lead qualification events
7. Call events

Key Points

• Webhooks can be configured to send lead data from RD Station to other tools that have a data input URL capable of reading JSON format.
• You can create up to 10 webhooks per RD Station Marketing account.
• The webhook payload is sent in JSON format and includes various lead information such as ID, email, name, company, job title, etc.
• Webhooks can be triggered by specific conversions or when a lead is marked as an opportunity.
• The RD Station API provides endpoints for creating, updating, listing, and deleting webhooks.

Code Example

Here's a Ruby code example for creating a webhook using the RD Station API client:

payload = {} # payload representing a webhook
client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
client.webhooks.create(payload)

Best Practices

1. When setting up webhooks, ensure that the receiving URL can handle JSON data.
2. Use descriptive names for your webhooks to easily identify their purpose.
3. Test your webhooks using temporary URL services like Beeceptor before implementing them in production.
4. Be aware that the webhook payload structure may change in the future, so design your integrations to be flexible.

In summary, the RD Station API offers robust webhook support, allowing you to subscribe to various event types and integrate RD Station data with other systems efficiently.

Rate Limits and other limitations

Here are the key points about the API rate limits for the RD Station API:

Rate Limits

• The RD Station API has rate limits to preserve the integrity and reliability of the platform [1].

• The rate limits vary depending on the specific API endpoint and plan level [1].

Specific Limits

• For consulting statistics of the sales funnel:

  • 60 requests per hour
  • GET method
  • Advanced plan only [1]

• For consulting statistics of conversion assets:

  • 60 requests per hour
  • GET method
  • Advanced plan only [1]

• For consulting email statistics via automation flow:

  • 60 requests per hour
  • GET method
  • Pro and Advanced plans [1]

• For updating a specific contact:

  • 24 requests per 24 hours
  • PATCH method
  • All plans (Light, Basic, Pro, Advanced) [1]

• For landing page endpoints:

  • 60 requests per hour
  • GET method
  • All plans (Light, Basic, Pro, Advanced) [1]

Error Handling

• If the rate limit is exceeded, you will receive a 429 "Too Many Requests" error [1].

• URLs over 8kb in length will receive a 414 "URI Too Long" error [1].

Best Practices

• Assume your application will compete for quotas and resources with other apps.
• Avoid simultaneous API calls if not needed.
• Use asynchronous requests when possible to better handle limits and errors [1].

Summary

The RD Station API implements various rate limits based on the specific endpoint and plan level. Limits generally range from 24-60 requests per hour or day. Exceeding limits results in 429 errors. Following best practices around efficient API usage is recommended.

Latest API Version

Based on the search results provided, I could not find a specific mention of the most recent version number for the RD Station API. However, I can provide some key information about the RD Station API:

Key Points:

1. The RD Station API is constantly evolving, and the best way to get the most up-to-date information is to consult the official documentation on the RD Station Developers Portal.

2. RD Station Marketing works with two types of authentication for their API:

   • OAuth2: Used for most API operations including sending events, updating contacts, querying information, etc.
   • API Keys: Used specifically for sending conversion events to create and update leads.

3. The base domain for all API calls to RD Station Marketing is https://api.rd.services.

4. The API follows RESTful principles and returns all responses, including errors, in JSON format.

Best Practices:

1. Always refer to the official Developers Portal for the most current information on API endpoints and methods.

2. Use OAuth2 authentication for broader access to API features, and API Keys for specific conversion event tracking.

3. When integrating with RD Station Marketing, consider becoming an integration partner for potential business expansion opportunities.

4. Familiarize yourself with RESTful API concepts if you haven't worked with them before.

While I couldn't provide the specific version number you asked for, it's important to note that APIs often evolve without explicit version numbers. The best approach is to regularly check the official documentation for any updates or changes to the API.

How to get a RD Station developer account and API Keys?

1. Sign up for a partnership account

• Go to the RD Station App Store and sign up to become an Integration Partner.
• By signing the Partnership Terms and Conditions, you'll get free access to an RD Station Marketing PRO Plan account (5,000 Leads) for testing and managing your app.

2. Choose your authentication method

There are two main options:

1. API Key

   • Simpler method, only for private integrations
   • Used for conversion form integrations and internal systems sending conversions
   • Limited to 5 keys per account

2. OAuth Authentication

   • Recommended for more advanced use cases and public apps
   • Required for publishing apps in the RD App Store

3. Set up your integration

For API Key:

• Go to the RD Station Marketing App Store
• Log in and click "Generate Key"
• Name your key and set its status (enabled/disabled)
• Copy the key code to use in your integration

For OAuth:

• Follow the authentication flow guide on the RD Station developers portal
• Register your app in the RD Station App Store
• Set up callback URLs and other required information

4. Develop and test your integration

• Use the provided PRO account to test your integration thoroughly
• Refer to the RD Station API documentation for implementation details

5. Publish your app (optional)

• If you want to make your app public, submit it for review to be listed in the RD App Store

What can you do with the RD Station API?

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

Contacts

• Query and update contact information
• Create and update leads through conversion events

Events

• Generate various types of events, including:
  • Conversion events
  • E-commerce events
  • Lead qualification events
  • Chat events
  • Call events

Analytics

• Retrieve account analytics information

Segmentation Lists

• Work with information from segmentation lists

Forms, Pop-ups, and Landing Pages

• Retrieve data from forms
• Retrieve data from pop-ups
• Retrieve data from landing pages

Email Marketing

• Retrieve data from email sends

Automated Workflows

• Retrieve data from automated workflows

Webhooks

• Send contacts to other platforms through webhooks

Authentication

• Two types of authentication are supported:
  1. OAuth: Allows access to all endpoints in your plan to send and receive data
  2. API Keys: Limited to sending standard conversion events to create and update leads

Key Points to Consider:

• The API is RESTful and accessed via HTTP
• All API responses, including errors, are returned in JSON format
• The base domain for all API calls is https://api.rd.services
• The API uses predictable URLs for accessing resources and HTTP response codes for indicating errors
• The available endpoints and features may vary depending on your RD Station Marketing plan
• For the most up-to-date information on available methods, it's recommended to consult the official documentation on the RD Station Developers Portal

It's important to note that the RD Station API is constantly evolving, so new features and endpoints may be added over time. Always refer to the latest documentation for the most accurate and comprehensive information on what's possible with the API.