Sign in

v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
Webhooks

Update a webhook

Update a webhook

put/api/webhooks/{heron_id}

Path parameters

heron_idstring required

Request body

headersobject nullable

Headers to send webhook with

heron_idstring

Unique ID for webhook generated by Heron

is_enabledboolean

Whether the webhook is enabled

topic'data_source.enabled' | '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' | 'end_user_file.parsed' | 'end_user_file.parse_failed' | 'end_user_file.processed_standalone' | 'end_user_file.deleted' | 'end_user_files.processing_failed' | 'enricher.succeeded' | 'enricher.failed' | 'pricing_template.generation_succeeded' | 'pricing_template.generation_failed' | 'pricing_template.delivery_succeeded' | 'pricing_template.delivery_failed' | 'workflow.event'

Webhook topic for different Heron events

urlstring url

URL where webhook should be sent

Example request

{
  "headers": {
    "Content-Type": "application/json"
  },
  "heron_id": "wbh_cg24fVTxHHwvMt574wrnKj",
  "is_enabled": true,
  "topic": "end_user.processed",
  "url": "https://www.your-webhook-endpoint.com/heron"
}

Response

Ok

Example response

{
  "webhook": {
    "headers": {
      "Content-Type": "application/json"
    },
    "heron_id": "wbh_cg24fVTxHHwvMt574wrnKj",
    "is_enabled": true,
    "topic": "end_user.processed",
    "url": "https://www.your-webhook-endpoint.com/heron"
  }
}