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

Creating a goal

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

This endpoint allows you to automate the process of creating goals in the Beenia Application through integration tools. You can use it to easily create goals with defined parameters.

Request

  • Method: POST
  • Path: /external/v0/zapier/webhooks/goals
  • Header:
  • X-KEY: API key for authentication.
  • Input object (in JSON format), which includes the following fields:
  • teamId(number): 
  • Identifier of the team to which the goal belongs.
  • Required field.
  • name(string): Name of the goal.
  • description(string): Description of goal.
  • goalType(string): Type of goal. 
  • Activity (ACTIVITY) or Metric (METRIC) goal.
  • decimals(number): Number of decimal places for goal values.
  • Only for metric goals.
  • goalValue(decimal): Goal value.
  • Only for metric goals.
  • value(decimal): Current value of goal.
  • Only for metric goals.
  • metricUnit(string): Unit of measurement for the goal metric.
  • Only for metric goals.

Response

After successfully creating the goal, the response will be in JSON format and will contain a confirmation of the goal creation along with the following information:

{

  "name": "Testing name of goal",

  "description": "Description of goal",

  "startDate": null,

  "endDate": null,

  "sortOrder": 362,

  "parentGoalId": null,

  "goalType": "ACTIVITY",

  "id": 79098,

  "state": "OPEN",

  "statusId": 0,

  "statusName": null,

  "teamId": 20500147,

  "teamName": "Testing name of team",

  "ownerId": 13450875,

  "ownerName": "John Dark",

  "createdAt": "2023-09-18T07:23:17.815Z",

  "assignee": [],

  "tenant": 409785,

  "metric": null,

  "deleted": false,

  "calcNumOpenSubGoals": 0

}


Description of attributes:

  • id: Unique identifier of the goal in the system.
  • name: Field containing the name of the goal. It is a string that describes what the goal is about.
  • description: Contains the description of the goal. It is a text string that provides a description of the goal.
  • startDate: Contains the start date of the goal. If the value is null, it means the goal does not have a specified start date.
  • endDate: This field contains the end date of the goal. If the value is null, it indicates that the goal does not have a specified end date.
  • sortOrder: A number that determines the order of the goal in the list of goals or hierarchical tree of goals.
  • parentGoalId: Identifier of the parent goal if the goal is part of the goal hierarchy. If it is not part of the hierarchy, it has a null value.
  • goalType: Defines the type of goal. It can take on the values "ACTIVITY" and "METRIC."
  • state: Defines the state of the goal. The state can be "OPEN" or "CLOSED," depending on whether the goal is active or closed.
  • statusId: Contains the identifier of the goal's status.
  • statusName: Contains the name of the goal's status.
  • teamId: Identifier of the team or group to which the goal belongs.
  • ownerId: Field containing the identifier of the goal's owner.
  • createdAt: This field contains the date and time of goal creation.
  • assignee: This field may contain information about assigned individuals who are responsible for achieving the goal.
  • tenant: This field contains the identifier of the tenant or organization associated with the goal.
  • metric: This field contains the metric used to measure the goal.
  • metricUnit: Units of the metric.
  • decimals: Number of decimal places for the metric.
  • goalValue: Target value of the metric.
  • value: Current value of the metric.
  • id: Unique identifier of the metric.
  • goalId: Identifier of the goal to which this metric belongs.
  • synchronizedValue: Information about whether the metric value is synchronized (false indicates it is not synchronized).
  • dataSource: External data source for the metric.
  • hubspotDataType: Data type of the metric in the HubSpot system.
  • syncDataKey: Key for data synchronization of the metric.
  • lastSyncAt: Date and time of the last synchronization of metric data.
  • status: Metric status.
  • deleted: Identifier of whether the goal is marked as deleted (true) or not (false).
  • calcNumOpenSubGoals: This number indicates the quantity of open sub-goals that are part of this goal.

‍

‍

‍