Customer.io API C# implementation

Partial implementation of Customer.io's APIs for .NET, focused on getting events into Customer.io.

Installation

Using Nuget:

Install-Package CustomerIOSharp

Usage (track API)

This API requires a site ID and API key (not to be confused with an app API key). It provides write-only access to user-specific sections of the API.

We recommend you implement the ICustomerFactory interface yourself. Here is a suggested implementation used in one of my projects:

    public class CustomerFactory : ICustomerFactory
    {
        public ICustomerDetails GetCustomerDetails()
        {
            var user = MembershipHelper.GetCurrentUser();
            return user == null 
                ? null 
                : user.AsCustomer();
        }

        public string GetCustomerId()
        {
            var user = MembershipHelper.GetCurrentUser();
            return user == null
                ? null
                : user.UserId.ToString();
        }
    }

Then instantiate TrackApi and call IdentifyAsync():

var customerIo = new TrackApi(
    "siteid", 
    "apikey", 
    new CustomerFactory());
await customerIo.IdentifyAsync();

You should most likely only call IdentifyAsync() whenever the user logs in or is changed.

If you do not want to implement ICustomerFactory, you can simply provide the required details to each call:

await customerIo.IdentifyAsync(User.AsCustomer());

Whatever you do, you will have to provide customer data implementing ICustomerDetails. It has only two required properties, but any properties you supply in your implementation will be forwarded to customer.io:

public class Customer : ICustomerDetails 
{
    // these two fields are required:
    public string Id { get; set; }
    public string Email { get; set; }
    // these are my custom fields:
    public string FirstName { get; set; }
    public string LastName { get; set; }
}

Custom events

Track a custom event by calling TrackEvent(). It takes an event name as the first parameter, the second parameter is any serializable object. Note that it automatically posts using the correct customer (using ICustomerFactory), but you can also supply your own.

await customerIo.TrackEventAsync("signup", new {
	UserGroup = "trial",
	Referrer = "email campaign"
});

// this event has no data and uses a different customer
await customerIo.TrackEventAsync("signup", customerId: "foo");

Note that these two variables will be camelcased before being sent to customer.io, so userGroup and referrer will be available in your transactional campaigns.

Usage (app API)

This API requires an app API key (a Bearer token). When you have it, it allows you to trigger broadcasts.

var customerIo = new AppApi("appAPIkey");
await customerIo.TriggerBroadcastAsync(
    BroadcastCampaignId, 
    new
    {
        Name = "Name 1",
        TestKey = "Value 2"
    });

This serializes to provide the following data to as part of the broadcast event:

{
    'name': 'Name 1',
    'testKey': 'Value 2'
}

Running tests locally

To run the tests, you need a customer.io account, and to provide the following environment variables:

• CIOS_SITE_ID -- site id
• CIOS_API_KEY -- API key matching the site id
• CIOS_APP_API_KEY -- app API key
• CIOS_BROADCAST_CAMPAIGN_ID -- ID of an API-triggered campaign
• CIOS_BROADCAST_SEGMENT_ID -- ID of an API-triggered segment

You can do that in two ways; either by setting the environment variables on the machine where you run the tests, or by creating a test.runsettings file in the CustomerIOSharp.Tests project.

<RunSettings>
	<RunConfiguration>
		<EnvironmentVariables>
			<CIOS_SITE_ID>site id</CIOS_SITE_ID>
			<CIOS_API_KEY>api key</CIOS_API_KEY>
			<CIOS_APP_API_KEY>app api key</CIOS_APP_API_KEY>
			<CIOS_BROADCAST_SEGMENT_ID>1</CIOS_BROADCAST_SEGMENT_ID>
			<CIOS_BROADCAST_CAMPAIGN_ID>2</CIOS_BROADCAST_CAMPAIGN_ID>
		</EnvironmentVariables>
	</RunConfiguration>
</RunSettings>

To make this file work with xUnit, you need to also add <RunSettingsFilePath>$(MSBuildProjectDirectory)\test.runsettings</RunSettingsFilePath> to the <PropertyGroup> in the CustomerIOSharp.Test.csproj file.

License

Dual licensed under the MIT and the GPL license.

You don’t have to do anything special to choose one license or the other and you don’t have to notify anyone which license you are using.

MIT license

The MIT License (MIT)

Copyright (c) 2013-2022 Digital Creations AS.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

GPL license

Copyright (c) 2013-2022 Digital Creations AS.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.