API Reference

Create a webhook subscription

post
https://app.pennylane.com/api/external/v2/webhook_subscriptions

Creates a webhook subscription to receive real-time notifications for events occurring within your company or companies.

Authentication & Scope

Subscription scope:

  • Company-scoped token (developer token or OAuth token bound to a specific company): the subscription is scoped to that single company.
  • App-bound token (OAuth token without a company context): the subscription covers all companies accessible by the OAuth application.

Limits
Up to 10 webhook subscriptions are allowed per company (for company-scoped tokens) or per subscriber (for app-bound tokens).

Secret
The secret will be auto-generated.

🔒

The secret is only returned in the creation response and cannot be retrieved afterwards. Make sure to store it securely.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
ℹ️

This endpoint requires the following scope: companies:webhook_subscriptions:all

Body Params
uri
required

HTTPS URL where webhook events will be sent

events
array of strings
required
length ≥ 1

Array of event types to subscribe to.

  • customer_invoice.e_invoicing_status_updated: the event is triggered when a customer invoice e-invoicing status is updated.
  • dms_file.created: the event is triggered when a dms file is created.
  • supplier_invoice.e_invoicing_received: the event is triggered when a supplier e-invoice is received via the Pennylane PA (Plateforme Agrée).
events*
Allowed:
boolean
Defaults to true

Indicates whether the webhook subscription is active

Responses

Updated 2 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago