Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

Creating an activity

This endpoint allows you to automate the process of creating activities in the Beenia application

This endpoint allows you to automate the process of creating activities in the Beenia application through integration tools. You can use it to easily create activities with defined parameters and ensure that your users have up-to-date information about their tasks and activities.

Request

  • Method: POST
  • Path: /external/v0/zapier/webhooks/activities
  • Header:
  • X-KEY: API key for authentication.
  • Input object (in JSON format), which includes the following fields:
  • name(string): The name of the activity.
  • Required field.
  • description(string): Description of the activity.
  • ownerTeamId Identifier of the team to which the activity belongs. If set to null, the activity will be created in the TODO activities of the authenticated user.
  • priority(string): Priority of the activity. Can take on 3 values: "LOW," "MEDIUM," and "HIGH".
  • tagIds (array of numbers): Identifiers of tags assigned to the activity.
  • dueDate(date and time): Due date of the activity.
  • sectionId(number): Identifier of the section where the activity should be placed.
  • Can be filled in only if the value of ownerTeamId is not null.
  • followerIds (array of numbers): Identifiers of people who are following the activity.
  • Can be filled in only if the value of ownerTeamId is not null.
  • assignedGoalIds (array of numbers): Identifiers of goals assigned to the activity.
  • Can be filled in only if the value of ownerTeamId is not null.
  • gtdId(number): Identifier of the GTD (Getting Things Done) project.
  • Can be filled in only if the value of ownerTeamId is null.
  • assigneeIds (array of numbers): Identifiers of assigned individuals.
  • Can be filled in only if the value of ownerTeamId is not null.

Response

After successfully creating an activity, the response in JSON format will contain a confirmation of the activity creation with the following information:

{

    "name": "testing activity task",

    "dueDate": null,

    "externalId": null,

    "id": 55503877,

    "reportedState": null,

    "assignee": [],

    "followers": [],

    "section": null,

    "tags": {

        "6850": "tag1",

        "6851": "tag2"

    },

    "state": "OPEN",

    "parentActivity": null,

    "calcNumOpenSubActivities": 0,

    "deleted": false,

    "kanban": null,

    "lastModified": "2023-09-18T08:21:00.569Z",

    "calcComments": 0,

    "sortOrder": 5.000000239745E11,

    "priority": "MEDIUM",

    "delegationRootActivityId": null,

    "delegationTargetActivityId": null,

    "delegationTargetActivityIsActive": false,

    "customFields": {},

    "owner": {

        "id": 13450454,

        "fullName": "John Black"

    },

    "backgroundId": null,

    "description": "

Description of task

",

    "tenant": 409,

    "ownerInfo": null,

    "ownerTeam": {

        "id": 20500874,

        "name": "Testing team"

    },

    "createdAt": "2023-09-18T08:20:31.659Z",

    "deletedAt": null,

    "delegationRootActivityTeamId": null,

    "delegationTargetActivityTeamId": null

}


Description of attributes:

  • name: A string describing the name of the task or activity.
  • dueDate: This field contains the date when the activity is due.
  • externalId: This field contains the external identifier of the activity if available.
  • id: This is a unique identifier of the activity in the system.
  • reportedState: This field contains the reported state of the activity if reported.
  • assignee: This field contains assigned individuals or teams to the activity.
  • followers: This field contains individuals who are following the activity.
  • section: This field contains information about the section to which the activity is assigned.
  • tags: This field contains tags assigned to the activity. Each tag is identified by its identifier and name.
  • state: This field defines the state of the activity. It can be "OPEN" or "CLOSED," depending on whether the activity is active or closed.
  • parentActivity: This field contains the identifier of the parent activity if the activity is part of an activity hierarchy.
  • calcNumOpenSubActivities: This number indicates the count of open sub-activities that are part of this activity.
  • deleted: This field indicates whether the activity is marked as deleted (true) or not (false).
  • kanban: This field contains information about the status of the activity.
  • lastModified: This field contains the date of the last modification of the activity.
  • priority: This field defines the priority of the activity. Priority can be set to "MEDIUM," "LOW," or "HIGH," characterizing the importance of the activity.
  • delegationRootActivityId: This field contains the identifier of the parent activity if the activity is part of delegation tasks.
  • delegationTargetActivityId: This field contains the identifier of the target activity within delegation tasks.
  • delegationTargetActivityIsActive: This field indicates whether the target activity within delegation tasks is active (true) or not (false).
  • customFields: This field may contain additional custom fields or information associated with the activity.
  • owner: This field contains information about the owner of the activity, including the identifier and full name.
  • backgroundId: This field contains the identifier of the background associated with the activity.
  • description: This field contains the description of the activity. The description may be in HTML format.
  • tenant: This field contains the identifier of the tenant or organization associated with the activity.
  • ownerTeam: This field contains information about the team of the activity owner, including the identifier and team name.
  • createdAt: This field contains the date and time of activity creation.
  • deletedAt: This field contains the date and time of activity deletion if it's deleted.
  • delegationRootActivityTeamId: This field contains the identifier of the team of the parent activity within delegation tasks.

‍