API Resource: Entity Interactions

Heads up! MonkeyPod's API is only available to Enterprise users and requires significant technical expertise to use. The API is considered to be in "beta" and remains under active development. We will make reasonable efforts to ensure its stability, but make no guarantees, warranties, or promises with respect to its availability or performance. 

Entity Interactions represent touch points with your relationships. They are logged:

  • By MonkeyPod users when they interact with a specific relationship
  • By MonkeyPod users in bulk, applied to relationship search results
  • Automatically by MonkeyPod when certain events happen, like a donation, a mailing list subscription, etc.

There are two supported endpoints for Entity Interactions:

  1. Retrieve a collection of interactions for a specific entity
  2. Create an Entity Interaction

Retrieve a Collection of Interactions for a Specific Entity

Method: GET
Endpoint: https://[YOUR-SUBDOMAIN].monkeypod.io/api/v2/entities/[ENTITY-ID]/interactions

Sample request:

GET https://my-org.monkeypod.io/api/v2/entities/9656e382-241c-4d29-b730-7200ef4b181e/interactions

Sample response:

{
  "data": [
    {
      "id": "9656e382-279d-4eb2-b0cd-b94d580f91db",
      "entity_id": "9656e382-241c-4d29-b730-7200ef4b181e",
      "type": "Phone Call",
      "description": "Spoke to her for a few minutes this morning. She seemed happy with the results of our recent work.",
      "link": null,
      "happened_at": "2022-05-19T09:15:00.000000Z",
      "flag": "positive",
      "created_at": "2022-05-19T22:28:03.000000Z",
      "updated_at": "2022-05-19T22:28:03.000000Z"
    },
    {
      "id": "9656e382-2743-4112-9706-87325706e739",
      "entity_id": "9656e382-241c-4d29-b730-7200ef4b181e",
      "type": "Meeting",
      "description": "We met to discuss a legacy gift.",
      "link": null,
      "happened_at": "2022-04-30T15:00:00.000000Z",
      "flag": null,
      "created_at": "2022-05-19T22:28:03.000000Z",
      "updated_at": "2022-05-19T22:28:03.000000Z"
    }
  ],
  "links": {
    "first": "https:\/\/my-org.monkeypod.io\/api\/v2\/entities\/9656e382-241c-4d29-b730-7200ef4b181e\/interactions?page=1",
    "last": null,
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "https:\/\/my-org.monkeypod.io\/api\/v2\/entities\/9656e382-241c-4d29-b730-7200ef4b181e\/interactions",
    "per_page": 15,
    "to": 2
  }
}

Create an Entity Interaction

Method: POST
Endpoint: https://[YOUR-SUBDOMAIN].monkeypod.io/api/v2/entities/[ENTITY-ID]/interactions

Sample request:

POST https://my-org.monkeypod.io/api/v2/entities/960a735b-3ee9-4440-9c6d-25cbf27c77fe/interactions

{
    "id": "9656ea5b-00ed-4410-9bd2-8f684cf7e96c",
    "type": "Phone Call",
    "description": "foo bar baz",
    "link": null,
    "happened_at": "2022-05-19T22:47:11.000000Z",
    "flag": null,
}

Sample response:

{
  "id": "9656ea5b-00ed-4410-9bd2-8f684cf7e96c",
  "resource": "entity_action",
  "data": {
    "id": "9656ea5b-00ed-4410-9bd2-8f684cf7e96c",
    "entity_id": "960a735b-3ee9-4440-9c6d-25cbf27c77fe",
    "type": "Phone Call",
    "description": "foo bar baz",
    "link": null,
    "happened_at": "2022-05-19T22:47:11.000000Z",
    "flag": null,
    "created_at": "2022-05-19T22:47:11.000000Z",
    "updated_at": "2022-05-19T22:47:11.000000Z"
  }
}