Ein Ziel erstellen

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: Feld, das die Kennung des Besitzers des Ziels enthält.
• Erstellt am: Dieses Feld enthält das Datum und die Uhrzeit der Zielerstellung.
• Rechtsnachfolger(in): Dieses Feld kann Informationen über zugewiesene Personen enthalten, die für das Erreichen des Ziels verantwortlich sind.
• Mieter: Dieses Feld enthält die Kennung des Mandanten oder der Organisation, der dem Ziel zugeordnet ist.
• metrisch: Dieses Feld enthält die Metrik, die zur Messung des Ziels verwendet wurde.
• Metrische Einheit: Einheiten der Metrik.

• Dezimalzahlen: Anzahl der Dezimalstellen für die Metrik.
• Zielwert: Zielwert der Metrik.
• Wert: Aktueller Wert der Metrik.
• id: Eindeutiger Bezeichner der Metrik.
• Ziel-ID: Identifier des Ziels, zu dem diese Metrik gehört.
• Synchronisierter Wert: Information darüber, ob der Metrikwert synchronisiert ist (falsch bedeutet, dass er nicht synchronisiert ist).
• Datenquelle: Externe Datenquelle für die Metrik.
• HubSpot-Datentyp: Datentyp der Metrik im HubSpot-System.
• Datenschlüssel synchronisieren: Schlüssel für die Datensynchronisierung der Metrik.
• Letzte Synchronisation: Datum und Uhrzeit der letzten Synchronisation der Metrikdaten.
• Status: Metrischer Status.

• gelöscht: Identifiziert, ob das Ziel als gelöscht markiert ist (wahr) oder nicht (falsch).
• Calcnum Offene Unterziele: Diese Zahl gibt die Anzahl der offenen Unterziele an, die Teil dieses Ziels sind.

‍

‍

‍