Skip to main content
POST
/
webhook_subscriptions
Subscribe to a webhook
curl --request POST \
  --url https://api.sandbox.monite.com/v1/webhook_subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "url": "https://example.com/your-webhook-listener",
  "object_type": "entity",
  "event_types": [
    "created",
    "onboarding_requirements.updated",
    "onboarding_requirements.status_updated"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "event_types": [
    "<string>"
  ],
  "object_type": "account",
  "secret": "<string>",
  "status": "enabled",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required

Body

application/json
​
object_type
enum<string>
required

The object type to whose events you want to subscribe.

To subscribe to events from multiple object types, create a separate subscription for each object type.

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

"entity"

​
url
string<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.

Required string length: 1 - 2083
Example:

"https://example.com/your-webhook-listener"

​
event_types
string[]

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

Example:
[
  "created",
  "onboarding_requirements.updated",
  "onboarding_requirements.status_updated"
]

Response

Successful Response

​
id
string<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_types
string[]
required

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

Example:
[
  "created",
  "onboarding_requirements.updated",
  "onboarding_requirements.status_updated"
]
​
object_type
enum<string>
required

The object type associated with this webhook subscription.

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

"entity"

​
secret
string
required

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

Example:

"whsec_Iw3mr..."

​
status
enum<string>
required
Available options:
enabled,
disabled
​
url
string<uri>
required

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

Required string length: 1 - 2083
Example:

"https://example.com/your-webhook-listener"