Webhook subscriptions

Subscribe to a webhook

Related guide: Webhooks.

post/webhook_subscriptions

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/webhook_subscriptions
  • Auth: HTTP bearer

Headers

x-monite-versionstring required

Request body

event_typesstring[]

A list of events to subscribe to. If set to an empty array, the subscription includes all events triggered by the specified object_type.

object_type'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' required
urlstring uri required

An HTTPS URL to which Monite will send webhooks. This URL must be accessible over the public Internet, accept POST requests, and respond with status code 200. It must be a direct URL (no redirects).

The same URL can be used by multiple webhook subscriptions.

Response

Successful Response

idstring uuid required

A unique URL assigned to this webhook subscription. This ID is also included in the webhook data as the webhook_subscription_id field.

event_typesstring[] required

Events included in this webhook subscription. An empty array means the subscription includes all events triggered by the specified object_type.

object_type'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' required
secretstring required

The webhook signing secret for this subscriptions. You can use it to verify webhook signatures.

status'enabled' | 'disabled' required
urlstring uri required

URL to which the webhooks are sent. The same URL can be used by multiple webhook subscriptions.

Changes

No recorded changes to this operation across all 1 revision of this API.