Skip to content

Latest commit

 

History

History
85 lines (47 loc) · 1.73 KB

README.md

File metadata and controls

85 lines (47 loc) · 1.73 KB
Raw

NAME

WebService::Async::CustomerIO - unofficial support for the Customer.io service

SYNOPSIS

DESCRIPTION

new

Creates a new API client object

Usage: new(%params) -> obj

Parameters:

  • site_id
  • api_key
  • api_token

site_id

api_key

api_token

API endpoints:

There is 2 stable API for Customer.io, if you need to add a new method check the documentation for API which endpoint you need to use:

  • Tracking API - Behavioral Tracking API is used to identify and track customer data with Customer.io.
  • Regular API - Currently, this endpoint is used to fetch list of customers given an email and for sending API triggered broadcasts.

tracking_request

Sending request to Tracking API end point.

Usage: tracking_request($method, $uri, $data) -> future($data)

api_request

Sending request to Regular API end point with optional limit type.

Usage: api_request($method, $uri, $data, $limit_type) -> future($data)

new_customer

Creating new customer object

Usage: new_customer(%params) -> obj

new_trigger

Creating new trigger object

Usage: new_trigger(%params) -> obj

new_customer

Creating new customer object

Usage: new_customer(%params) -> obj

add_to_segment

Add people to a manual segment.

Usage: add_to_segment($segment_id, @$customer_ids) -> Future()

remove_from_segment

remove people from a manual segment.

usage: c<< remove_from_segment($segment_id, @$customer_ids) -> future() >>

get_customers_by_email

Query Customer.io API for list of clients, who has requested email address.

usage: c<< get_customers_by_email($email)->future([$customer_obj1, ...]) >>