PEpennylane
Webhooks

Create a webhook subscription

Changed on

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.

post/api/external/v2/webhook_subscriptions

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/v2/webhook_subscriptions
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token

Request body

callback_urlstring uri required

HTTPS URL where webhook events will be sent

eventsstring[] required

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).
enabledboolean

Indicates whether the webhook subscription is active

Example request

{
  "callback_url": "https://example.com/webhooks",
  "events": [
    "dms_file.created",
    "customer_invoice.e_invoicing_status_updated",
    "supplier_invoice.e_invoicing_received"
  ]
}

Response

Renders the created webhook subscription

idinteger required

ID of the webhook subscription

callback_urlstring uri required

HTTPS URL where webhook events are sent

eventsstring[] required

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).
enabledboolean required

Indicates whether the webhook subscription is active

secretstring required

Automatically generated secret for HMAC signature verification. This is only returned once on creation. Store it securely as it cannot be retrieved afterwards.

created_atstring date-time required

Creation date of the webhook subscription

updated_atstring date-time required

Last update date of the webhook subscription

Example response

{
  "id": 12345,
  "callback_url": "https://example.com/webhooks",
  "events": [
    "dms_file.created",
    "customer_invoice.e_invoicing_status_updated",
    "supplier_invoice.e_invoicing_received"
  ],
  "enabled": true,
  "created_at": "2023-08-07T14:23:12.000Z",
  "updated_at": "2023-08-07T14:23:12.000Z"
}

Changes

  • 871f863307e5Revision changes
    • warning

      added the new supplier_invoice.e_invoicing_received enum value to the / response property for the response status

    • info

      api tag Webhooks added

    • info

      api tag Hidden removed

    • info

      added the new supplier_invoice.e_invoicing_received enum value to the request property /