ChurnZero

App · 18 actions

Work with ChurnZero, the customer success platform: find accounts, contacts, tasks, events, notes, meetings and survey responses, create and update accounts and contacts, track events and time in app, and start workflows when accounts, contacts, tasks and more change.

Actions

ActionWhat it does
Add to attributesAdd to (or, with a negative amount, take from) number attributes of an account or contact, such as a running total of reports sent.
Create or update accountCreate an account, or update one, by its external ID: its name, renewal, contract, owner, address and custom fields.
Create or update contactCreate a contact on an account, or update one, by their external IDs: name, email and custom fields.
Get accountGet one account with its contract, renewal, owner, ChurnScore and custom fields, by its ChurnZero id or by its external ID.
Get contactGet one contact, by its ChurnZero id or by the account's and contact's external IDs.
Get taskGet one task with its subject, comments, account, owner, status and due date.
List accountsList ChurnZero accounts, filtered by segment, active or not, name, owner, renewal date or recent change, and sorted.
List contactsList contacts, filtered by account, segment, email, name or recent change, and sorted.
List event typesList the event types events are tracked under, by name.
List eventsList tracked events (logins, feature use and the like), filtered by account, contact, event type, segment or time.
List meetingsList meetings, filtered by account, owner or start time.
List notesList notes, filtered by account, note type or date.
List segmentsList the segments you can use: your own and global ones, of accounts, contacts or events.
List survey responsesList NPS, CSAT and other survey responses, filtered by account, survey, score or date answered.
List tasksList tasks, filtered by account, owner, status, priority, open or closed, due date or recent change, and sorted.
List usersList your team's ChurnZero users, who own accounts and tasks.
Track eventRecord that a contact did something in your product, such as a login or a report sent, with an optional description, quantity and custom fields.
Track time in appRecord a stretch of time a contact spent in your product, optionally in one module of it.

Add to attributes

Add to (or, with a negative amount, take from) number attributes of an account or contact, such as a running total of reports sent.

Inputs

Attributes ofentitytextRequired
Whether the attributes are the account's or the contact's.One of: account, contact.
Account externalaccount_external_idtextRequired
The account's external ID: its ID in your own system or CRM, as ChurnZero knows it. Pick one, or type a new one to create the account.
Contact external IDcontact_external_idtext
The contact's external ID. Needed when the attributes are the contact's.
Amounts to addincrementsobjectRequired
Each number attribute's name with the amount to add, for example {"Reports Sent": 1}.

Outputs

acceptedtrue/false
True once ChurnZero's HTTP API took the call. It answers every call the same way, so read the record back to confirm the change
sentobject
What was sent, by ChurnZero's field names
Example output
{
  "accepted": true,
  "sent": {
    "accountExternalId": "acme-001",
    "action": "incrementAttribute",
    "attr_Reports Sent": "1",
    "entity": "account"
  }
}

Create or update account

Create an account, or update one, by its external ID: its name, renewal, contract, owner, address and custom fields. Only the fields given change. ChurnZero applies it within a few minutes and doesn't say whether it worked, so read the account back to confirm.

Inputs

Account externalaccount_external_idtextRequired
The account's external ID: its ID in your own system or CRM, as ChurnZero knows it. Pick one, or type a new one to create the account.
Namenametext
The account's name.
Activeis_activetext
Whether the account is active. Only active accounts are in segments, ChurnScores and reports.One of: active, inactive.
Next renewal datenext_renewal_datedate
When it next renews.
Total contract amounttotal_contract_amountnumber
The contract's value, a number such as 12000.50.
License countlicense_countnumber
How many licenses it has.At least 0.
Start datestart_datedate and time
When the contract started.
End dateend_datedate and time
When the contract ends.
Ownerowner_user_nametext
The ChurnZero user who owns the account, by username.
Parent account external IDparent_account_external_idtext
The external ID of the account this one belongs under.
Billing address line 1billing_address_line1text
Street address.
Billing address line 2billing_address_line2text
Suite, unit or floor.
Billing citybilling_address_citytext
City.
Billing statebilling_address_statetext
State or region.
Billing postal codebilling_address_ziptext
ZIP or postal code.
Other attributescustom_attributesobject
Custom fields (or other attributes) by name, with their values, for example {"Plan Tier": "Gold"}. The custom field must already exist in ChurnZero's Admin > Custom Fields.
Attributes to clearclear_attributeslist
Names of attributes to empty, such as NextRenewalDate or a custom field's name.

Outputs

acceptedtrue/false
True once ChurnZero's HTTP API took the call. It answers every call the same way, so read the record back to confirm the change
sentobject
What was sent, by ChurnZero's field names
Example output
{
  "accepted": true,
  "sent": {
    "accountExternalId": "acme-001",
    "action": "setAttribute",
    "attr_Name": "Acme Inc",
    "attr_NextRenewalDate": "2027-03-01T00:00:00Z",
    "entity": "account"
  }
}

Create or update contact

Create a contact on an account, or update one, by their external IDs: name, email and custom fields. Only the fields given change. Create the account first. ChurnZero applies it within a few minutes and doesn't say whether it worked, so read the contact back to confirm.

Inputs

Account externalaccount_external_idtextRequired
The account's external ID: its ID in your own system or CRM, as ChurnZero knows it. Pick one, or type a new one to create the account.
Contact external IDcontact_external_idtextRequired
The contact's external ID: their ID in your own system, such as a user id or email address.
First namefirst_nametext
The contact's first name.
Last namelast_nametext
The contact's last name.
Emailemailtext
The contact's email address.
Other attributescustom_attributesobject
Custom fields (or other attributes) by name, with their values, for example {"Plan Tier": "Gold"}. The custom field must already exist in ChurnZero's Admin > Custom Fields.
Attributes to clearclear_attributeslist
Names of attributes to empty, such as NextRenewalDate or a custom field's name.

Outputs

acceptedtrue/false
True once ChurnZero's HTTP API took the call. It answers every call the same way, so read the record back to confirm the change
sentobject
What was sent, by ChurnZero's field names
Example output
{
  "accepted": true,
  "sent": {
    "accountExternalId": "acme-001",
    "action": "setAttribute",
    "attr_Email": "jo@example.com",
    "contactExternalId": "user-77",
    "entity": "contact"
  }
}

Get account

Get one account with its contract, renewal, owner, ChurnScore and custom fields, by its ChurnZero id or by its external ID.

Inputs

Accountaccount_idtext
The account. Pick one, or give its ChurnZero id. Leave empty to find it by external ID instead.
Account external IDaccount_external_idtext
The account's ID in your own system or CRM, used when Account is empty.

Outputs

accountobject
The account
Example output
{
  "account": {
    "BillingAddressCity": "Baltimore",
    "BillingAddressCountry": "US",
    "BillingAddressLine1": "1 Main St",
    "BillingAddressLine2": "Suite 2",
    "BillingAddressState": "MD",
    "BillingAddressZip": "21201",
    "ContactsCount": 12,
    "CrmId": "0015g00000XyZAB",
    "EndDate": "2027-02-28T00:00:00Z",
    "ExternalId": "acme-001",
    "Id": 22433,
    "IsActive": true,
    "LicenseCount": 50,
    "Name": "Acme Inc",
    "NextRenewalDate": "2027-03-01T00:00:00Z",
    "NpsScore": 40,
    "ObjectCreatedDate": "2026-03-01T14:02:11.5Z",
    "ObjectLastModifiedDate": "2026-11-14T09:01:44.7Z",
    "ParentAccountId": 21389,
    "RelationshipScore": 8,
    "StartDate": "2026-03-01T00:00:00Z",
    "Tags": [
      "Enterprise"
    ],
    "TenureInDays": 262,
    "TotalContractAmount": "12000.00",
    "UserAccountId": 1220
  }
}

Get contact

Get one contact, by its ChurnZero id or by the account's and contact's external IDs.

Inputs

Contact IDcontact_idtext
The contact's ChurnZero id, from 'List contacts' or an earlier step. Leave empty to find it by external IDs instead.
Account external IDaccount_external_idtext
The account's ID in your own system, used with Contact external ID when Contact ID is empty.
Contact external IDcontact_external_idtext
The contact's ID in your own system, used with Account external ID when Contact ID is empty.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "AccountId": 22433,
    "CrmId": "0035g00000AbCDE",
    "Email": "jo@example.com",
    "ExternalId": "user-77",
    "FirstName": "Jo",
    "FullName": "Jo Bloggs",
    "Id": 1630,
    "LastName": "Bloggs",
    "MarketingEmailUnsubscribed": false,
    "ObjectCreatedDate": "2026-03-02T10:00:00Z",
    "ObjectLastModifiedDate": "2026-11-10T08:30:00Z",
    "Tags": [
      "Champion"
    ]
  }
}

Get task

Get one task with its subject, comments, account, owner, status and due date.

Inputs

Task IDtask_idtextRequired
The task's ChurnZero id, from 'List tasks' or an earlier step.

Outputs

taskobject
The task
Example output
{
  "task": {
    "AccountId": 22433,
    "CloseDate": "2026-11-21T09:00:00Z",
    "Comments": "Book the kick-off with the new champion.",
    "ContactId": 1630,
    "DueDate": "2026-11-20T17:00:00Z",
    "Id": 26350,
    "IsClosed": false,
    "IsHighPriority": true,
    "ObjectCreatedDate": "2026-11-14T09:01:45Z",
    "ObjectLastModifiedDate": "2026-11-15T12:00:00Z",
    "Subject": "Kick-off call",
    "TaskPriorityId": 2,
    "TaskStatusId": 1,
    "UserAccountId": 1220
  }
}

List accounts

List ChurnZero accounts, filtered by segment, active or not, name, owner, renewal date or recent change, and sorted. Gets one page of up to 100; to see more, run it again with Skip set to the next_skip it gives.

Inputs

Segmentsegment_idtext
Only accounts in this ChurnZero segment.
Activeactivetext
Active accounts, inactive ones, or both.One of: any (Active and inactive (default)), active (Active only), inactive (Inactive only).
Name containsname_containstext
Only accounts whose name contains this text (at least 2 letters).
Ownerowner_idtext
Only those owned by this ChurnZero user.
Renews on or afterrenewal_fromdate
Only accounts whose next renewal is on or after this day.
Renews on or beforerenewal_untildate
Only accounts whose next renewal is on or before this day.
Changed sincechanged_sincedate and time
Only those changed at or after this time.
Sort byorder_bytext
How to sort them.One of: Name (Name (default)), ObjectLastModifiedDate desc (Recently changed first), ObjectCreatedDate desc (Newest first), NextRenewalDate (Next renewal soonest), TotalContractAmount desc (Largest contract first).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 100, ChurnZero's most.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page: give the next_skip of the page before.At least 0.

Outputs

accountslist
The accounts
countnumber
How many are on this page
next_skipnumber
Give this as Skip to get the next page; 0 when there are no more
Example output
{
  "accounts": [
    {
      "BillingAddressCity": "Baltimore",
      "BillingAddressCountry": "US",
      "BillingAddressLine1": "1 Main St",
      "BillingAddressLine2": "Suite 2",
      "BillingAddressState": "MD",
      "BillingAddressZip": "21201",
      "ContactsCount": 12,
      "CrmId": "0015g00000XyZAB",
      "EndDate": "2027-02-28T00:00:00Z",
      "ExternalId": "acme-001",
      "Id": 22433,
      "IsActive": true,
      "LicenseCount": 50,
      "Name": "Acme Inc",
      "NextRenewalDate": "2027-03-01T00:00:00Z",
      "NpsScore": 40,
      "ObjectCreatedDate": "2026-03-01T14:02:11.5Z",
      "ObjectLastModifiedDate": "2026-11-14T09:01:44.7Z",
      "ParentAccountId": 21389,
      "RelationshipScore": 8,
      "StartDate": "2026-03-01T00:00:00Z",
      "Tags": [
        "Enterprise"
      ],
      "TenureInDays": 262,
      "TotalContractAmount": "12000.00",
      "UserAccountId": 1220
    }
  ],
  "count": 1,
  "next_skip": 0
}

List contacts

List contacts, filtered by account, segment, email, name or recent change, and sorted. Gets one page of up to 100; to see more, run it again with Skip set to the next_skip it gives.

Inputs

Accountaccount_idtext
Only this account. Pick one, or give its ChurnZero id from an earlier step.
Segmentsegment_idtext
Only contacts in this ChurnZero segment.
Emailemailtext
Only the contact with this email address.
Name containsname_containstext
Only contacts whose full name contains this text (at least 2 letters).
Changed sincechanged_sincedate and time
Only those changed at or after this time.
Sort byorder_bytext
How to sort them.One of: LastName (Last name (default)), ObjectLastModifiedDate desc (Recently changed first), ObjectCreatedDate desc (Newest first).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 100, ChurnZero's most.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page: give the next_skip of the page before.At least 0.

Outputs

contactslist
The contacts
countnumber
How many are on this page
next_skipnumber
Give this as Skip to get the next page; 0 when there are no more
Example output
{
  "contacts": [
    {
      "AccountId": 22433,
      "CrmId": "0035g00000AbCDE",
      "Email": "jo@example.com",
      "ExternalId": "user-77",
      "FirstName": "Jo",
      "FullName": "Jo Bloggs",
      "Id": 1630,
      "LastName": "Bloggs",
      "MarketingEmailUnsubscribed": false,
      "ObjectCreatedDate": "2026-03-02T10:00:00Z",
      "ObjectLastModifiedDate": "2026-11-10T08:30:00Z",
      "Tags": [
        "Champion"
      ]
    }
  ],
  "count": 1,
  "next_skip": 0
}

List event types

List the event types events are tracked under, by name. Gets one page of up to 100; to see more, run it again with Skip set to the next_skip it gives.

Inputs

Name containsname_containstext
Only event types whose name contains this text (at least 2 letters).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 100, ChurnZero's most.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page: give the next_skip of the page before.At least 0.

Outputs

countnumber
How many are on this page
event_typeslist
The event types
next_skipnumber
Give this as Skip to get the next page; 0 when there are no more
Example output
{
  "count": 1,
  "event_types": [
    {
      "Id": 18811,
      "Name": "Login",
      "ProductId": 13
    }
  ],
  "next_skip": 0
}

List events

List tracked events (logins, feature use and the like), filtered by account, contact, event type, segment or time. Gets one page of up to 100; to see more, run it again with Skip set to the next_skip it gives.

Inputs

Accountaccount_idtext
Only this account. Pick one, or give its ChurnZero id from an earlier step.
Contact IDcontact_idtext
Only events of this contact, by ChurnZero id.
Event typesevent_type_idslist
Only events of these types. Leave empty for every type.
Segmentsegment_idtext
Only events in this ChurnZero event segment.
Fromfrom_timedate and time
Only events at or after this time.
Untiluntil_timedate and time
Only events at or before this time.
Orderdirectiontext
Newest or oldest first.One of: desc (Newest first (default)), asc (Oldest first).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 100, ChurnZero's most.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page: give the next_skip of the page before.At least 0.

Outputs

countnumber
How many are on this page
eventslist
The events
next_skipnumber
Give this as Skip to get the next page; 0 when there are no more
Example output
{
  "count": 1,
  "events": [
    {
      "AccountId": 22433,
      "ContactId": 1630,
      "Description": "Weekly report",
      "EventDate": "2026-11-14T09:01:44Z",
      "EventTypeId": 18811,
      "Id": 13256,
      "Quantity": "1"
    }
  ],
  "next_skip": 0
}

List meetings

List meetings, filtered by account, owner or start time. Gets one page of up to 100; to see more, run it again with Skip set to the next_skip it gives.

Inputs

Accountaccount_idtext
Only this account. Pick one, or give its ChurnZero id from an earlier step.
Ownerowner_idtext
Only those owned by this ChurnZero user.
Starting fromfrom_timedate and time
Only meetings starting at or after this time.
Starting untiluntil_timedate and time
Only meetings starting at or before this time.
Orderdirectiontext
Newest or oldest first.One of: desc (Newest first (default)), asc (Oldest first).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 100, ChurnZero's most.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page: give the next_skip of the page before.At least 0.

Outputs

countnumber
How many are on this page
meetingslist
The meetings
next_skipnumber
Give this as Skip to get the next page; 0 when there are no more
Example output
{
  "count": 1,
  "meetings": [
    {
      "AccountId": 22433,
      "EndDate": "2026-11-12T16:00:00Z",
      "Id": 27137,
      "IsAllDay": false,
      "Location": "Zoom",
      "MeetingTypeId": 26,
      "ObjectCreatedDate": "2026-11-01T10:00:00Z",
      "Organizer": "sam@yourcompany.com",
      "StartDate": "2026-11-12T15:00:00Z",
      "Subject": "Quarterly business review",
      "Summary": "Reviewed adoption and the renewal.",
      "UserAccountId": 1220
    }
  ],
  "next_skip": 0
}

List notes

List notes, filtered by account, note type or date. Gets one page of up to 100; to see more, run it again with Skip set to the next_skip it gives.

Inputs

Accountaccount_idtext
Only this account. Pick one, or give its ChurnZero id from an earlier step.
Note typenote_type_idtext
Only notes of this type.
On or afterfrom_datedate
Only notes dated on or after this day.
On or beforeuntil_datedate
Only notes dated on or before this day.
Orderdirectiontext
Newest or oldest first.One of: desc (Newest first (default)), asc (Oldest first).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 100, ChurnZero's most.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page: give the next_skip of the page before.At least 0.

Outputs

countnumber
How many are on this page
next_skipnumber
Give this as Skip to get the next page; 0 when there are no more
noteslist
The notes
Example output
{
  "count": 1,
  "next_skip": 0,
  "notes": [
    {
      "AccountId": 22433,
      "Content": "Renewal looks likely; wants SSO.",
      "Id": 29822,
      "Name": "QBR notes",
      "NoteDate": "2026-11-12T15:00:00Z",
      "NoteTypeId": 16,
      "ObjectCreatedDate": "2026-11-12T16:00:00Z",
      "ObjectLastModifiedDate": "2026-11-12T16:00:00Z",
      "Sentiment": "Positive",
      "Tags": [
        "QBR"
      ]
    }
  ]
}

List segments

List the segments you can use: your own and global ones, of accounts, contacts or events. Gets one page of up to 100; to see more, run it again with Skip set to the next_skip it gives.

Inputs

Segment ofentitytext
Which kind of segment to list.One of: Account (Accounts (default)), Contact (Contacts), Event (Events), any (Every kind).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 100, ChurnZero's most.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page: give the next_skip of the page before.At least 0.

Outputs

countnumber
How many are on this page
next_skipnumber
Give this as Skip to get the next page; 0 when there are no more
segmentslist
The segments
Example output
{
  "count": 1,
  "next_skip": 0,
  "segments": [
    {
      "Entity": "Account",
      "Id": 6763,
      "IsGlobal": true,
      "Name": "All Accounts",
      "ObjectCreatedDate": "2018-10-14T01:38:36Z",
      "ObjectLastModifiedDate": "2020-09-03T14:56:56Z",
      "UserAccountId": 1220
    }
  ]
}

List survey responses

List NPS, CSAT and other survey responses, filtered by account, survey, score or date answered. Gets one page of up to 100; to see more, run it again with Skip set to the next_skip it gives.

Inputs

Accountaccount_idtext
Only this account. Pick one, or give its ChurnZero id from an earlier step.
Surveysurvey_idtext
Only responses to this survey.
Which responsespendingtext
Only answered surveys, or also those sent and not yet answered.One of: answered (Answered only (default)), any (Answered and waiting for an answer).
Score at leastmin_scorenumber
Only scores of at least this.
Score at mostmax_scorenumber
Only scores of at most this.
Answered on or afterfrom_datedate
Only responses answered on or after this day.
Answered on or beforeuntil_datedate
Only responses answered on or before this day.
Orderdirectiontext
Newest or oldest first.One of: desc (Newest first (default)), asc (Oldest first).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 100, ChurnZero's most.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page: give the next_skip of the page before.At least 0.

Outputs

countnumber
How many are on this page
next_skipnumber
Give this as Skip to get the next page; 0 when there are no more
responseslist
The survey responses
Example output
{
  "count": 1,
  "next_skip": 0,
  "responses": [
    {
      "AccountId": 22433,
      "Comment": "Great support.",
      "ContactId": 1630,
      "Id": 6849,
      "IsPending": false,
      "ResponseDate": "2026-11-11T10:30:00Z",
      "ResponseSource": "Email",
      "Score": 9,
      "SentDate": "2026-11-10T09:00:00Z",
      "Sentiment": "Positive",
      "SurveyId": 24
    }
  ]
}

List tasks

List tasks, filtered by account, owner, status, priority, open or closed, due date or recent change, and sorted. Gets one page of up to 100; to see more, run it again with Skip set to the next_skip it gives.

Inputs

Accountaccount_idtext
Only this account. Pick one, or give its ChurnZero id from an earlier step.
Ownerowner_idtext
Only those owned by this ChurnZero user.
Statusstatus_idtext
Only tasks in this status.
Priority levelpriority_idtext
Only tasks at this priority level.
Open or closedstatetext
Open tasks, closed ones, or both.One of: any (Open and closed (default)), open (Open only), closed (Closed only).
Priorityprioritytext
Every task, or only high-priority ones.One of: any (Any priority (default)), high (High priority only).
Due on or afterdue_fromdate
Only tasks due on or after this day.
Due on or beforedue_untildate
Only tasks due on or before this day.
Changed sincechanged_sincedate and time
Only those changed at or after this time.
Sort byorder_bytext
How to sort them.One of: DueDate (Due soonest (default)), ObjectLastModifiedDate desc (Recently changed first), ObjectCreatedDate desc (Newest first).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 100, ChurnZero's most.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page: give the next_skip of the page before.At least 0.

Outputs

countnumber
How many are on this page
next_skipnumber
Give this as Skip to get the next page; 0 when there are no more
taskslist
The tasks
Example output
{
  "count": 1,
  "next_skip": 0,
  "tasks": [
    {
      "AccountId": 22433,
      "CloseDate": "2026-11-21T09:00:00Z",
      "Comments": "Book the kick-off with the new champion.",
      "ContactId": 1630,
      "DueDate": "2026-11-20T17:00:00Z",
      "Id": 26350,
      "IsClosed": false,
      "IsHighPriority": true,
      "ObjectCreatedDate": "2026-11-14T09:01:45Z",
      "ObjectLastModifiedDate": "2026-11-15T12:00:00Z",
      "Subject": "Kick-off call",
      "TaskPriorityId": 2,
      "TaskStatusId": 1,
      "UserAccountId": 1220
    }
  ]
}

List users

List your team's ChurnZero users, who own accounts and tasks. Gets one page of up to 100; to see more, run it again with Skip set to the next_skip it gives.

Inputs

Activeactivetext
Active users, inactive ones, or both.One of: any (Active and inactive (default)), active (Active only), inactive (Inactive only).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 100, ChurnZero's most.From 1 to 100.
Skipskipnumber
How many to skip, to get a later page: give the next_skip of the page before.At least 0.

Outputs

countnumber
How many are on this page
next_skipnumber
Give this as Skip to get the next page; 0 when there are no more
userslist
The users
Example output
{
  "count": 1,
  "next_skip": 0,
  "users": [
    {
      "CanLogIn": true,
      "Email": "sam@yourcompany.com",
      "FirstName": "Sam",
      "Id": 1220,
      "IsActive": true,
      "LastName": "Lee",
      "Name": "Sam Lee",
      "ObjectCreatedDate": "2020-01-06T15:00:00Z",
      "Title": "Customer Success Manager",
      "UserName": "sam@yourcompany.com"
    }
  ]
}

Track event

Record that a contact did something in your product, such as a login or a report sent, with an optional description, quantity and custom fields. A new event name creates its event type. The same event (date, account, contact and description) is recorded once unless duplicates are allowed.

Inputs

Account externalaccount_external_idtextRequired
The account's external ID: its ID in your own system or CRM, as ChurnZero knows it. Pick one, or type a new one to create the account.
Contact external IDcontact_external_idtextRequired
The contact's external ID: their ID in your own system, such as a user id or email address.
Event nameevent_nametextRequired
What happened, such as Login. Pick an existing event type or type a new name.
Event dateevent_datedate and time
When it happened. Defaults to now.
Descriptiondescriptiontext
A note about this one event, such as a report's title. ChurnZero keeps the first 255 characters.
Quantityquantitynumber
A number for the event, such as how many emails were sent.
Allow duplicatesallow_duplicatestrue/false
Record it even if the same event is already there.
Custom fieldscustom_fieldsobject
Event custom fields by name, with values. Each must already exist in ChurnZero's Admin > Custom Fields > Events.

Outputs

acceptedtrue/false
True once ChurnZero's HTTP API took the call. It answers every call the same way, so read the record back to confirm the change
sentobject
What was sent, by ChurnZero's field names
Example output
{
  "accepted": true,
  "sent": {
    "accountExternalId": "acme-001",
    "action": "trackEvent",
    "contactExternalId": "user-77",
    "eventDate": "2026-11-18T10:00:00Z",
    "eventName": "Login"
  }
}

Track time in app

Record a stretch of time a contact spent in your product, optionally in one module of it.

Inputs

Account externalaccount_external_idtextRequired
The account's external ID: its ID in your own system or CRM, as ChurnZero knows it. Pick one, or type a new one to create the account.
Contact external IDcontact_external_idtextRequired
The contact's external ID: their ID in your own system, such as a user id or email address.
Startstart_timedate and timeRequired
When they started.
Endend_timedate and timeRequired
When they stopped.
Modulemoduletext
The part of your product they used. ChurnZero uses Default when empty.

Outputs

acceptedtrue/false
True once ChurnZero's HTTP API took the call. It answers every call the same way, so read the record back to confirm the change
sentobject
What was sent, by ChurnZero's field names
Example output
{
  "accepted": true,
  "sent": {
    "accountExternalId": "acme-001",
    "action": "trackTimeInApp",
    "contactExternalId": "user-77",
    "endDate": "2026-11-18T09:20:00Z",
    "startDate": "2026-11-18T09:00:00Z"
  }
}

On this page