Overview
Aircall
This CDK catalogue package is pinned to @activepieces/piece-aircall@0.2.0 and declares 8 declared actions and 5 declared triggers. Its definition is derived from the exact reviewed Activepieces source.
Provider runtime verification is recorded separately when an approved test connection is exercised; this catalogue entry does not claim that verification.
Technical guide
Technical reference
- Package:
@activepieces/piece-aircall@0.2.0 - Exact artifact digest:
sha256:999fd6e00c7d2763596d9edc56ae62c524c1e83ff28f396ba7d29003337d00c9 - Source: the exact reviewed Activepieces source
- Authentication, action and trigger schemas are taken from the exact pinned package.
Capability summary
Authentication
Authentication method: basic
Authentication profiles
connection · basic
- Username Required
- Password Required · protected credential
Supported objects
| Object | Read | Write | Notes |
|---|---|---|---|
| Comment a Call | Yes | No | |
| Create a Contact | Yes | No | |
| Find Call | Yes | No | |
| Find Contact | Yes | No | |
| Get Call | Yes | No | |
| Tag a Call | Yes | No | |
| Update Contact | Yes | No | |
| Custom API Call | Yes | No | |
| Call Ended | Yes | No | Trigger contract validated offline; live event delivery is tracked separately. |
| New Contact | Yes | No | Trigger contract validated offline; live event delivery is tracked separately. |
| New Note | Yes | No | Trigger contract validated offline; live event delivery is tracked separately. |
| New Number Created | Yes | No | Trigger contract validated offline; live event delivery is tracked separately. |
| New SMS | Yes | No | Trigger contract validated offline; live event delivery is tracked separately. |
Supported actions
Comment a Call · Read
Adds a comment (note) to a specific call.
comment_acall · Risk: low · Retry: safe
Inputs
callId· string · Requiredcontent· string · Required
Create a Contact · Read
Creates a new contact.
create_acontact · Risk: low · Retry: safe
Inputs
phone_numbers· array · Requiredfirst_name· string · Optionallast_name· string · Optionalcompany_name· string · Optionalinformation· string · Optional, Additional information about the contact.emails· array · Optional, Array of email addresses (optional, max 20)
Find Call · Read
Finds specific call based on provided filter.
find_calls · Risk: low · Retry: safe
Inputs
direction· string · Optional, Filter by call directionphone_number· string · Optional, The calling or receiving phone number of calls.tags· array · Optional
Find Contact · Read
Finds contact based on phone or email.
find_contact · Risk: low · Retry: safe
Inputs
phone_number· string · Optional, Search by phone number (with country code, e.g., +1234567890).email· string · Optional, Search by email address.
Get Call · Read
Retrieves details about a specific call.
get_call · Risk: low · Retry: safe
Inputs
callId· string · Required
Tag a Call · Read
Add tags to a specific call.
tag_acall · Risk: low · Retry: safe
Inputs
callId· string · Requiredtags· array · Optional
Update Contact · Read
Update an existing contact.
update_contact · Risk: low · Retry: safe
Inputs
contactId· string · Required, Select the contact to updatefirst_name· string · Optionallast_name· string · Optional, Last name of the contactcompany_name· string · Optionalinformation· string · Optional, Additional information about the contact
Custom API Call · Read
Make a custom API call to a specific endpoint
custom_api_call · Risk: low · Retry: safe
Inputs
url· object · Requiredmethod· string · Requiredheaders· object · Optional, Authorization headers are injected automatically from your connection.queryParams· object · Optional, Appended to the URL as ?key=value.body_type· string · Optionalbody· object · Optionalresponse_is_binary· boolean · Optional, Enable for files like PDFs, images, etc.failsafe· boolean · Optional, On a failed request, output the error instead of failing the step.timeout· number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).followRedirects· boolean · Optional, Follow 3xx redirects instead of returning them as the response.
Triggers
Call Ended · Webhook
Triggers when a call ends.
New Contact · Webhook
Triggers when a new contact is created.
New Note · Webhook
Triggers when a new note is added to a call.
New Number Created · Webhook
Triggers when a new number is created.
New SMS · Webhook
Triggers when a new SMS message is received.
Setup
Setup
Create a tenant connection only in the consuming Studio instance when this connector is made available there. Credentials remain in that tenant's Vault-backed connection and are not stored in CDK package metadata.
Limitations
The package has passed deterministic offline package-load and contract validation. No provider credentials, provider API call or live webhook delivery is represented by this release state.