API Reference

Create a webhook subscription

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

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

Authentication & Scope

  • Developer Token: The subscription is scoped to the single company linked to the token.
  • OAuth Application Access Token: The subscription covers all companies accessible by the OAuth application.

Limit: Only one webhook subscription is allowed per OAuth Application or Developer Token.

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…
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.created: the event is triggered when a customer invoice is created.
  • quote.created: the event is triggered when a quote is created.
  • dms_file.created: the event is triggered when a dms file is created.
events*
boolean
Defaults to true

Indicates whether the webhook subscription is active

Responses

Updated 8 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 8 days ago