POST
/
api
/
webhooks
curl --request POST \
  --url https://app.herondata.io/api/webhooks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "headers": {
    "Content-Type": "application/json"
  },
  "is_enabled": true,
  "topic": "end_user.processed",
  "url": "https://www.your-webhook-endpoint.com/heron"
}'
{
  "headers": {
    "Content-Type": "application/json"
  },
  "heron_id": "wbh_nG2VqzqbDaG7GmzSDwKoBh",
  "is_enabled": true,
  "topic": "end_user.processed",
  "url": "https://www.your-webhook-endpoint.com/heron"
}

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

Example:
{ "Content-Type": "application/json" }
​
is_enabled
boolean

Whether the webhook is enabled

Example:

true

​
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.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
Example:

"end_user.processed"

​
url
string

URL where webhook should be sent

Example:

"https://www.your-webhook-endpoint.com/heron"

Response

201 - application/json
Created
​
headers
object | null

Headers to send webhook with

Example:
{ "Content-Type": "application/json" }
​
heron_id
string

Unique ID for webhook generated by Heron

Example:

"wbh_nG2VqzqbDaG7GmzSDwKoBh"

​
is_enabled
boolean

Whether the webhook is enabled

Example:

true

​
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.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
Example:

"end_user.processed"

​
url
string

URL where webhook should be sent

Example:

"https://www.your-webhook-endpoint.com/heron"

Was this page helpful?