Goal payloads

The following webhook example payloads are sent to your webhook URL when Goals are created or updated.

goalCreated payload

This webhook is triggered when a Goal is created.

{
  "event": "goalCreated",
  "goal_id": "a23e5a3d-74b5-44c2-ab53-917ebe85045a",
  "webhook_id": "d5eddb2d-db2b-49e9-87d4-bc6cfbe2313b"
}

goalUpdated payload

This webhook is triggered when a Goal is updated.

{
  "event": "goalUpdated",
  "goal_id": "a23e5a3d-74b5-44c2-ab53-917ebe85045a",
  "webhook_id": "d5eddb2d-db2b-49e9-87d4-bc6cfbe2313b"
}

goalDeleted payload

This webhook is triggered when a Goal is deleted.

{
  "event": "goalDeleted",
  "goal_id": "a23e5a3d-74b5-44c2-ab53-917ebe85045a",
  "webhook_id": "d5eddb2d-db2b-49e9-87d4-bc6cfbe2313b"
}

Target (key result) payloads

The following webhook example payloads are sent to your webhook URL when Goal Targets (key results) are created or updated.

keyResultCreated payload

This webhook is triggered when a Target of a Goal is created.

{
  "event": "keyResultCreated",
  "goal_id": "a23e5a3d-74b5-44c2-ab53-917ebe85045a",
  "key_result_id": "47608e42-ad0e-4934-a39e-950539c77e79",
  "webhook_id": "d5eddb2d-db2b-49e9-87d4-bc6cfbe2313b"
}

keyResultUpdated payload

This webhook is triggered when a Target of a Goal is updated.

{
  "event": "keyResultUpdated",
  "goal_id": "a23e5a3d-74b5-44c2-ab53-917ebe85045a",
  "key_result_id": "47608e42-ad0e-4934-a39e-950539c77e79",
  "webhook_id": "d5eddb2d-db2b-49e9-87d4-bc6cfbe2313b"
}

keyResultDeleted payload

This webhook is triggered when a Target of a Goal is deleted.

{
  "event": "keyResultDeleted",
  "goal_id": "a23e5a3d-74b5-44c2-ab53-917ebe85045a",
  "key_result_id": "47608e42-ad0e-4934-a39e-950539c77e79",
  "webhook_id": "d5eddb2d-db2b-49e9-87d4-bc6cfbe2313b"
}