Batch Transfer Webhooks

Astra sends webhooks whenever a Batch Transfer is created or the status is updated.

Batch Transfer Created

Fired when the Batch Transfer is created.

ParameterData TypeDescription
webhook_typestringbatch_transfer_created
webhook_idstringThe unique ID of the webhook event
user_idstringThe unique ID of the User
resource_idstringThe unique ID of the Resource (Batch Transfer ID)

Example:

{
  "webhook_type": "batch_transfer_created",
  "webhook_id": "364f57aa-47dd-461b-8df4-d6388fb2d05e",
  "user_id": "WV9Zwexqw7Tqk8nox5dBSe993dEBqGulDlnNA",
  "resource_id": "0239decedaaa5cefa4d173ee839ca37599165219"
}

Batch Transfer Updated

Fired when the status of a Batch Transfer has changed.

ParameterData TypeDescription
webhook_typestringbatch_transfer_updated
webhook_idstringThe unique ID of the webhook event
user_idstringThe unique ID of the User
resource_idstringThe unique ID of the Resource (Batch Transfer ID)

Example:

{
  "webhook_type": "batch_transfer_updated",
  "webhook_id": "364f57aa-47dd-461b-8df4-d6388fb2d05e",
  "user_id": "WV9Zwexqw7Tqk8nox5dBSe993dEBqGulDlnNA",
  "resource_id": "0239decedaaa5cefa4d173ee839ca37599165219"
}