PHPackages                             openinbound/openinbound-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. openinbound/openinbound-api

ActiveLibrary[API Development](/categories/api)

openinbound/openinbound-api
===========================

API for the OpenInbound analytics server

118PHP

Since May 19Pushed 8y ago1 watchersCompare

[ Source](https://github.com/lukasfischer/openinbound-api)[ Packagist](https://packagist.org/packages/openinbound/openinbound-api)[ RSS](/packages/openinbound-openinbound-api/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

openinbound-api
===============

[](#openinbound-api)

Usage
-----

[](#usage)

```
$oi = new OI('YOUR_TRACKING_ID', 'YOUR_API_KEY');
```

Note: You'll find your tracking id and API on the settings page on app.openinbound.com.

Examples
--------

[](#examples)

Update an existing contact
--------------------------

[](#update-an-existing-contact)

```
    $data['email'] = 'email'
    $data['first_name'] = 'Joe';
    $data['last_name'] = 'Long';
    $data['company_name'] = 'Company LCC';
    $data['phone'] = '041 450 10 66';
    $oi = new OI('YOUR_TRACKING_ID', 'YOUR_API_KEY');
    $oi->updateContact($_COOKIE['_oi_contact_id'], $data);
```

Log a custom event to the OpenInbound backend
---------------------------------------------

[](#log-a-custom-event-to-the-openinbound-backend)

```
    $data['title'] = 'This title will be sent in the OpenInbound event list';
    $data['event_type'] = 'raw';
    $data['raw'] = 'Whatever data you want to send.';
    $oi = new OI('YOUR_TRACKING_ID', 'YOUR_API_KEY');
    $oi->addEvent($_COOKIE['_oi_contact_id'], $data);
```

Note: The $\_COOKIE\['\_oi\_contact\_id'\] will be automatically set by the OpenInbound tracking script.

Get in touch
------------

[](#get-in-touch)

If you need further assistance, please contact

---

\# API Reference ### Contact Entity
--------------

[](#contact-entity)

### Properties

[](#properties)

emailContacts email addressfirst\_nameFirst name of contactlast\_nameLast name of contactcompany\_nameCompany name of contactphonePhone number of contactEvent Entity
------------

[](#event-entity)

### Properties

[](#properties-1)

contact\_idContact idevent\_typeEvent type (pageview, lifecycle\_stage\_changed, submission, raw)titleThe "title" of the event.rawAny data you want to save.

###  Health Score

21

—

LowBetter than 19% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/a406316868d42715d1b25ce1bf88f8c1edf5c6be1ba398494ebf1d9ce107869b?d=identicon)[lukasfischer](/maintainers/lukasfischer)

---

Top Contributors

[![lukasfischer](https://avatars.githubusercontent.com/u/4563426?v=4)](https://github.com/lukasfischer "lukasfischer (19 commits)")

### Embed Badge

![Health badge](/badges/openinbound-openinbound-api/health.svg)

```
[![Health](https://phpackages.com/badges/openinbound-openinbound-api/health.svg)](https://phpackages.com/packages/openinbound-openinbound-api)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)