Skip to main content
POST
/
webhook_subscriptions
/
{webhook_subscription_id}
/
enable
Enable a webhook subscription
curl --request POST \
  --url https://api.sandbox.monite.com/v1/webhook_subscriptions/{webhook_subscription_id}/enable \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "event_types": [
    "<string>"
  ],
  "object_type": "account",
  "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

Path Parameters

​
webhook_subscription_id
string<uuid>
required

ID of the webhook subscription. This is the same value as the webhook_subscription_id you receive in webhooks.

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"

​
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"