View as Markdown
Hyros icon

Hyros ACTION

Create Call

Create a new call. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Hyros account once, then configure and run Create Call from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "hyros-create-call",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hyros: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    email: "Email",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Call inputs
Property Type Description
name Name string
The name of the call.
Required
email Email string
Email associated with the lead that made the call.
Optional
firstName First Name string
First name of the lead that made the call.
Optional
lastName Last Name string
Last name of the lead that made the call.
Optional
leadIps Lead IPs string[]
IPs of the customer that made the call. Will be used on the Ad attributing process.
Optional
phoneNumbers Phone Numbers string[]
Phone numbers of the lead that made the call. Will be used on the Ad attributing process.
Optional
id Id string
Identifier by which the call will be grouped. A default id will be assigned if it is not included.
Optional
date Date string
Date on which the transaction was processed. The date must be written in accordance with ISO 8601. Format: YYYY-MM-DDThh:mm:ss
Optional
qualified Qualified boolean
A flag that indicates if the call should be marked as unqualified. If it's not present the call is created as qualified.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
hyros-create-call
Version
0.0.3
App
Hyros
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes