Aha! Roadmaps | Integrate with activity webhooks

JSON fields

The audit webhook provides a live stream of events occuring within Aha! to a service that you create and run yourself. This allows custom logic to be implemented by your team to extend Aha!'s capabilities, or provide further auditing to meet regulatory concerns.

Each audit webhook contains a single JSON object, which has the following fields:

• /event

  • This is always audit.

• /audit/id

  • This is the numeric, 64-bit ID of the audit record. It will be presented as a string.

• /audit/audit_action

  • This is the action which was performed. It will be one of create, update, or destroy.

• /audit/created_at

  • This is the timestamp at which the audit was created.

• /audit/interesting

  • This field is used internally in the Aha! notification system.

• /audit/user/id

  • This is the numeric, 64-bit ID of the user or integration who performed this action, cast into a string.

• /audit/user/name

  • This is the name of the user who performed this action. This may also be the name of the integration which performed the action.

• /audit/user/email

  • This is the email address of the user who performed this action

• /audit/user/created_at

  • This is the date which the user in question joined your Aha! account.

• /audit/user/updated_at

  • This is the date when the user's information was last changed. This field is updated frequently for cache-breaking purposes.

• /audit/contributors

  • This is an array of user records, similar to the /audit/user field. It represents all of the users whose changes were collated into this audit, for example, if multiple users were collaboratively editing a record at the same time. See the Collation section, below this list of fields.

• /audit/auditable_type

  • This is the type of record which is being changed. Common values are feature, release, requirement, strategic_imperative (goal), strategic_initiative (initiative), attachment, comment, and note. Objects of every kind in your Aha! account will be represented by these types.

• /audit/auditable_id

  • This is the numeric, 64-bit ID of the record being changed. It will be formatted as string.

• /audit/associated_type

  • For some records, such as comments or note records (which hold long-form text descriptions), the auditable id itself is not helpful. The associated record is the record to which to auditable record is attached. For instance, a comment on an idea will result in an audit with an Auditable type of Comment and an Associated type of Idea.

    This field is nullable.

• /audit/associated_id

  • This is the numeric, 64-bit ID of the associated record record. It will be formatted as string.

    This field is nullable.

• /audit/changes

  • The changes array collects all of the changes made for this and collated audits.

• /audit/changes[0]/field_name

  • The field_name parameter indicates the name of the field that was changed.

• /audit/changes[0]/value

  • The value indicates the new value as a result of these changes.

Top

Collation

Your Aha! account is a highly collaborative tool, allowing many users to make updates to a single record at the same time. In cases of long-form text fields, multiple users can even edit the same field at the same time. As a result, the audit records generated by editing a record are collated together after a short interval. This collation process prevents a very large amount of useless and hard to understand audits.

When audit collation happens, the changes for a record will be collapsed into the changes block, and the users whose changes have been merged in will be added to the contributors field.

The audit integration will receive all audits, even those which are later collated into other records.

Top