POST
/
api
/
webhooks

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
headers
object | null

Headers to send webhook with

is_enabled
boolean

Whether the webhook is enabled

topic
enum<string>

Webhook topic for different Heron events

Available options:
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.approved,
integration_link.erroring,
iso_application.processed,
iso_application.processed_simple,
iso_application.created,
end_user_email.processed,
end_user_email.failed,
debt_summary.processed,
end_user_file.parsed,
end_user_file.parse_failed
url
string

URL where webhook should be sent

Response

201 - application/json
headers
object | null

Headers to send webhook with

heron_id
string

Unique ID for webhook generated by Heron

is_enabled
boolean

Whether the webhook is enabled

topic
enum<string>

Webhook topic for different Heron events

Available options:
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.approved,
integration_link.erroring,
iso_application.processed,
iso_application.processed_simple,
iso_application.created,
end_user_email.processed,
end_user_email.failed,
debt_summary.processed,
end_user_file.parsed,
end_user_file.parse_failed
url
string

URL where webhook should be sent