API StatusPartner Portal
HomeGuidesAPI ExplorerSDKsGitHubSupport
HomeGuidesAPI ExplorerSDKsGitHubSupport
  • API Concepts
    • Overview
    • Environments and URLs
    • Authentication
    • API versioning
    • Rate limiting
    • HTTP headers
    • Pagination, sorting, and filtering
  • General
  • Common
  • Accounts payable
  • Accounts receivable
  • E-invoicing
  • Payments
  • Accounting integration
  • Expense management
  • Utilities
LogoLogo
API StatusPartner Portal
GeneralWebhook subscriptions

POST
/webhook_subscriptions/:webhook_subscription_id/enable
POST
/v1/webhook_subscriptions/:webhook_subscription_id/enable
1curl -X POST https://api.sandbox.monite.com/v1/webhook_subscriptions/webhook_subscription_id/enable \
2 -H "x-monite-version: 2024-05-25" \
3 -H "Authorization: Bearer <token>"
Try it
1{
2 "id": "id",
3 "event_types": [
4 "created",
5 "onboarding_requirements.updated",
6 "onboarding_requirements.status_updated"
7 ],
8 "object_type": "account",
9 "status": "enabled",
10 "url": "https://example.com/your-webhook-listener"
11}
Was this page helpful?
Previous

Regenerate a webhook secret and return the new webhook subscription

Next
Enable a webhook subscription

Authentication

AuthorizationBearer

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

Path parameters

webhook_subscription_idstringRequired

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

Headers

x-monite-versionstringRequired

Response

Successful Response
idstringformat: "uuid"

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

event_typeslist of strings

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

object_typeenum
The object type associated with this webhook subscription.
statusenum
Allowed values:
urlstringformat: "uri">=1 character<=2083 characters
URL to which the webhooks are sent. The same URL can be used by multiple webhook subscriptions.

Errors

Successful Response