curl --request GET \
--url https://app.herondata.io/api/webhooks \
--header 'x-api-key: <api-key>'{
"webhooks": [
{
"headers": {
"Content-Type": "application/json"
},
"heron_id": "wbh_m3hoVGzUGUNxRjVkbu7oHv",
"is_enabled": true,
"topic": "end_user.processed",
"url": "https://www.your-webhook-endpoint.com/heron"
}
]
}Get webhook
curl --request GET \
--url https://app.herondata.io/api/webhooks \
--header 'x-api-key: <api-key>'{
"webhooks": [
{
"headers": {
"Content-Type": "application/json"
},
"heron_id": "wbh_m3hoVGzUGUNxRjVkbu7oHv",
"is_enabled": true,
"topic": "end_user.processed",
"url": "https://www.your-webhook-endpoint.com/heron"
}
]
}Ok
Show child attributes
Unique ID for webhook generated by Heron
"wbh_m3hoVGzUGUNxRjVkbu7oHv"
Whether the webhook is enabled
true
Webhook topic for different Heron events
data_source_account_summary.created, data_source.disabled, end_user.created, end_user.processed, end_user.failed, end_user.reviewed, end_user.transactions_updated, end_user.review_required, end_user.files_changed, end_user.files_classified, end_user_information.updated, end_user.policy_workflow_finished, end_user.policy_workflow_failed, enrich_workflow.finished, transactions.deleted, transactions.updated, pdf.processed, pdf.checks_passed, pdf.checks_failed, pdf.transactions_loaded, pdf.failed, pdf.parsed, pdf.human_reviewing, pdf.approved, integration_link.erroring, iso_application.processed, iso_application.processed_simple, iso_application.created, iso_application.failed, end_user_email.processed, end_user_email.failed, debt_summary.processed, end_user_file.parsed, end_user_file.parse_failed, end_user_file.processed_standalone, end_user_file.deleted, enricher.succeeded, enricher.failed "end_user.processed"
URL where webhook should be sent
"https://www.your-webhook-endpoint.com/heron"
Was this page helpful?