POST
/
core
/
webhooks

Authorizations

api_key
string
headerrequired

Body

application/json

The data of the webhooks endpoint

webhook
object
required

The data of the webhook

Response

200 - application/json

The data of the invite link endpoint

id
string
required

The ID of the webhook

headers
object
required

The headers of the webhook

operations
enum<string>[]
required

The operations of the webhook

Available options:
CREATE,
UPDATE,
DELETE
data_models
enum<string>[]
required

The data models of the webhook

Available options:
ACCOUNTS,
BANK_ACCOUNTS,
BILLS,
BILL_PAYMENTS,
COMPANY_INFO,
CONTACTS,
BILL_CREDIT_NOTES,
INVOICE_CREDIT_NOTES,
DOCUMENTS,
EXPENSES,
INVOICES,
INVOICE_PAYMENTS,
ITEMS,
LINE_ITEMS,
TAX_RATES,
JOURNAL_ENTRIES,
BANK_TRANSACTIONS,
JOURNAL_LINES,
PURCHASE_ORDERS,
SALES_ORDERS,
PHONE_NUMBERS,
ADDRESSES,
EXTERNAL_LINKS,
CONTACT_PERSONS,
INCOME_STATEMENT,
BALANCE_SHEET,
TRACKING_CATEGORIES,
CASH_FLOW_STATEMENT,
CURRENCIES,
PAYMENT_CUSTOMERS,
PAYMENT_INVOICES,
PAYMENT_LINE_ITEMS,
PAYMENT_ITEMS,
PAYMENT_ORDERS,
PAYMENT_TAX_RATES,
PAYMENT_DISPUTES,
PAYMENT_PAYMENTS,
PAYMENT_REFUNDS,
PAYMENT_PAYMENT_LINKS,
PAYMENT_PAYOUTS,
PAYMENT_ADDRESSES,
PAYMENT_PHONE_NUMBERS,
PAYMENT_EXTERNAL_LINKS,
PAYMENT_TRANSACTIONS,
PAYMENT_BALANCES,
ECOMMERCE_ORDERS,
ECOMMERCE_CUSTOMERS,
ECOMMERCE_PRODUCTS,
ECOMMERCE_LINE_ITEMS,
CRM_CONTACTS,
CRM_COMPANIES,
CRM_DEALS,
CRM_LEADS,
CRM_NOTES,
CRM_PIPELINES,
CRM_STAGES,
CRM_ACTIVITIES,
CRM_TASKS,
CRM_USERS,
CRM_EXTERNAL_LINKS,
CRM_PHONE_NUMBERS,
CRM_ADDRESSES
name
string
required

The name of the webhook

created_at
string
required

The date the webhook was created

type
enum<string>
required

The type of the webhook

Available options:
DATA_MODEL_CHANGES,
CONNECTION_CHANGED,
SYNC_COMPLETED
url
string
required

The URL of the webhook

Get WebhooksUpdate Webhook