Skip to main content
POST
Subscribe to a webhook

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-finops-version
string<date>
required

Body

application/json
object_type
enum<string>
required
Available options:
account,
accounting_connection,
approval,
approval_request,
approval_policy,
approval_policy_process,
batch_payment,
comment,
counterpart,
counterpart_address,
counterpart_bank_account,
counterpart_contact_person,
counterpart_partner_metadata,
counterpart_tax_id,
entity,
entity_bank_account,
entity_settings,
entity_user,
export,
overdue_reminder,
partner_settings,
payable,
payables_credit_note,
payables_purchase_order,
payable.line_item,
payment,
payment_intent,
payment_link,
payment_reminder,
product,
project,
receivable,
recurrence,
role,
tag,
todo_task,
workflow,
workflow_pipeline,
ocr_task,
delivery_note,
receipt,
transaction
url
string<uri>
required
Required string length: 1 - 2083
event_types
string[]

Callbacks

POST
{$request.body.url}webhook_notification

Body

application/json
id
string<uuid>
required
action
string
required
api_version
string | null
required
description
string
required
entity_id
string<uuid>
required
object_type
enum<string>
required
Available options:
account,
accounting_connection,
approval,
approval_request,
approval_policy,
approval_policy_process,
batch_payment,
comment,
counterpart,
counterpart_address,
counterpart_bank_account,
counterpart_contact_person,
counterpart_partner_metadata,
counterpart_tax_id,
entity,
entity_bank_account,
entity_settings,
entity_user,
export,
overdue_reminder,
partner_settings,
payable,
payables_credit_note,
payables_purchase_order,
payable.line_item,
payment,
payment_intent,
payment_link,
payment_reminder,
product,
project,
receivable,
recurrence,
role,
tag,
todo_task,
workflow,
workflow_pipeline,
ocr_task,
delivery_note,
receipt,
transaction
webhook_subscription_id
string<uuid>
required
created_at
string<date-time> | null

The timestamp that was generated at the time of making the database transaction that has initially caused the event

object
unknown

Response

Successful Response

Response

Successful Response

id
string<uuid>
required
event_types
string[]
required
object_type
enum<string>
required
Available options:
account,
accounting_connection,
approval,
approval_request,
approval_policy,
approval_policy_process,
batch_payment,
comment,
counterpart,
counterpart_address,
counterpart_bank_account,
counterpart_contact_person,
counterpart_partner_metadata,
counterpart_tax_id,
entity,
entity_bank_account,
entity_settings,
entity_user,
export,
overdue_reminder,
partner_settings,
payable,
payables_credit_note,
payables_purchase_order,
payable.line_item,
payment,
payment_intent,
payment_link,
payment_reminder,
product,
project,
receivable,
recurrence,
role,
tag,
todo_task,
workflow,
workflow_pipeline,
ocr_task,
delivery_note,
receipt,
transaction
secret
string
required
status
enum<string>
required
Available options:
enabled,
disabled
url
string<uri>
required
Required string length: 1 - 2083