User Webhooks

Astra sends webhooks whenever there is a status update for a User or UserIntent.

User Intent Updated

Fired when the status of a UserIntent has changed.

ParameterData TypeDescription
webhook_typestringuser_intent_updated
webhook_idstringThe unique ID of the webhook event
user_idstringThe unique ID of the User Intent
resource_idstringThe unique ID of the Resource (UserIntent ID)
metadataobjectOptional, only visible if specified during User Intent creation

Example:

{
  "webhook_type": "user_intent_updated",
  "webhook_id": "364f57aa-47dd-461b-8df4-d6388fb2d05e",
  "user_id": "WV9Zwexqw7Tqk8nox5dBSe993dEBqGulDlnNA",
  "resource_id": "WV9Zwexqw7Tqk8nox5dBSe993dEBqGulDlnNA",
  "metadata": {
    "custom_field_name_1": "custom value",
    "custom_field_name_2": "custom value 2"
  }
}

User Updated

Fired when the status of a User has changed.

📘

When a User is closed for your client, you'll receive a user_updated webhook once the close completes, and the User's status then reads closed. Only your client receives it. Other clients the User is linked to aren't notified, because their status for the User doesn't change.

ParameterData TypeDescription
webhook_typestringuser_updated
webhook_idstringThe unique ID of the webhook event
user_idstringThe unique ID of the User
resource_idstringThe unique ID of the Resource (User ID)
metadataobjectOptional, only visible if specified during User Intent creation

Example:

{
  "webhook_type": "user_updated",
  "webhook_id": "364f57aa-47dd-461b-8df4-d6388fb2d05e",
  "user_id": "WV9Zwexqw7Tqk8nox5dBSe993dEBqGulDlnNA",
  "resource_id": "WV9Zwexqw7Tqk8nox5dBSe993dEBqGulDlnNA",
  "metadata": {
    "custom_field_name_1": "custom value",
    "custom_field_name_2": "custom value 2"
  }
}