Sign in

v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB
Activity

attachActivity

Attach existing activity to entity activity feeds

post/v1/entity/activity/{id}:attach

Path parameters

idstring ulid required

See https://github.com/ulid/spec

Example:01F130Q52Q6MWSNS8N2AVXV4JN

Activity Id

Query parameters

entitiesEntityId[]

Comma-separated list of entities which the activity primarily concerns

Response

Success

_idstring ulid

See https://github.com/ulid/spec

timestampstring date-time
typestring required

A type for the activity. Used to categorize activities in the activity feed and for event subscriptions.

Built-in entity activity types (custom activities can be defined as well):

  • EntityCreated
  • EntityUpdated
  • EntityDeleted
  • EntitySoftDeleted
  • EntityRestored
  • RelationsAdded
  • RelationsRemoved
  • RelationsSoftDeleted
  • RelationsRestored
  • RelationsDeleted
  • ChangesetCreated
  • ChangesetAutoCleared
  • ChangesetApplied
  • ChangesetDismissed
titlestring required

Title for activity. Supports handlebars syntax.

messagestring required

Message for activity. Supports handlebars syntax.

payloadobject
pendingboolean

Indicates whether the activity is in the pending state. Pending activities are not yet visible in the activity feed and events are not yet dispatched.

Example response

{
  "_id": "01F130Q52Q6MWSNS8N2AVXV4JN",
  "title": "My custom activity",
  "message": "{{caller}} did something with {{entity payload.entity.id}}.",
  "payload": {
    "entity": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "schema": "contact"
    }
  },
  "caller": {
    "EpilotAuth": {
      "token": {
        "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",
        "cognito:groups": [
          "Administrator"
        ],
        "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",
        "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",
        "custom:ivy_org_id": "739224",
        "cognito:username": "n.ahmad@epilot.cloud",
        "custom:ivy_user_id": "10006129",
        "cognito:roles": [
          "arn:aws:iam::912468240823:role/base-administrator-role"
        ],
        "aud": "6e0jbdnger7nmoktaaflarue1l",
        "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",
        "token_use": "id",
        "auth_time": 1614333023,
        "exp": 1614336623,
        "iat": 1614333023,
        "email": "n.ahmad@epilot.cloud"
      }
    }
  }
}