BookedIn icon

BookedIn

Interact with BookedIn AI agents, leads, campaigns, strategies, lists, and human messaging
Join our community

Actions29

Overview

This node integrates with the BookedIn API to manage marketing and sales automation entities such as agents, leads, lists, strategies, campaigns, and human messaging. Specifically, for the Campaign - Get operation, it retrieves detailed information about a specific campaign by its unique ID.

Use cases include:

  • Fetching campaign details to monitor or report on ongoing marketing efforts.
  • Integrating campaign data into workflows for further processing or decision-making.
  • Automating campaign management tasks by retrieving current campaign configurations.

Example: You have a campaign running targeting a list of leads with a particular strategy. Using this node's "Get Campaign" operation, you can retrieve the campaign's metadata, status, and configuration to update dashboards or trigger other workflow steps.

Properties

Name Meaning
Campaign ID The unique identifier of the campaign to retrieve (e.g., camp_1234567890). This is a required string input.

Output

The node outputs a JSON object representing the campaign details retrieved from the BookedIn API. The structure typically includes fields such as:

  • id: Campaign unique identifier.
  • name: Campaign name.
  • list_id: Identifier of the lead list targeted by the campaign.
  • strategy_id: Identifier of the strategy used in the campaign.
  • description: Optional description of the campaign.
  • Other metadata related to campaign status, creation date, and configuration.

The output is provided as an array of JSON objects, each corresponding to one input item processed.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the BookedIn API.
  • The node makes HTTP requests to endpoints under https://api.bookedin.ai/api/v1/campaigns/.
  • Proper network connectivity to the BookedIn API service is necessary.
  • No additional environment variables are required beyond the configured API authentication.

Troubleshooting

  • Invalid Campaign ID: If the provided campaign ID does not exist or is malformed, the API will return an error. Verify the campaign ID format and existence.
  • Authentication Errors: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • Network Issues: Connectivity problems may cause request failures; check your network and proxy settings.
  • API Rate Limits: Excessive requests might be throttled by the API; consider adding delays or handling rate limit errors gracefully.
  • Unexpected Response Structure: If the API changes, the output structure might differ. Review API documentation for updates.

Links and References

Discussion