Webhooks are messages sent automatically from one app to another. Paidnice can send a webhook message to another app when actions or escalations are processed. This can work with tools like Zapier to automate your accounts receivable processes.
Sending webhooks from Paidnice is a pro feature available on the Pro plan. If you need to connect your late fee process with other tools and services with webhooks please subscribe to the Pro plan to take advantage of this feature.
If you do not have access to webhooks on your current plan you'll see a warning like this:
Webhooks in Paidnice
Configure your webhook URL in the advanced organisation settings, in the example below we are using a Zapier url:
There are two types of webhook message: Actions and Escalations.
Actions webhooks relate to the actions on the Actions page of Paidnice - for example sending a reminder email or applying a late fee. Any time an action completes or fails, a webhook will be sent.
The content of the action webhook is JSON in this format:
contact:
accountingSystemId: c94a5733-bef8-432f-999d-372f94d10570
customerName: ABC Furniture
status: ACTIVE
primaryContactPerson:
isPrimaryContact: true
firstName: Bob
lastName: Jones
email: [email protected]
mobileNumber: 473123456
mobileCountryCode: 0061
contactPersons:
0:
isPrimaryContact: false
firstName: Trish
lastName: Rawlings
email: [email protected]
invoice:
accountingSystemInvoiceId: 5f180e97-715a-48c2-84d6-496bbb8d18ab
invoiceReference: INV-0041
invoiceNumber: INV-0042
invoiceDueDate: 2024-01-23T00:00:00.000Z
invoiceCurrency: USD
invoiceTotal: 8888.58
invoiceBalanceDue: 8888.58
portalLink: https://example-portal-link.com
policy:
policyId: 24
policyTitle: Fixed Late Fee
policyType: late_fee
extraPolicies:
0:
policyId: 25
policyTitle: Percent Late Fee
policyType: late_fee
actionId: 44120242-ddde-4ce9-9bbb-86f88647e7c4
actionType: late_fee
actionStatus: complete
actionDate: 2024-02-22T00:00:00.000Z
webhookOnly: false
If the action is of type send_sms then it will also include the below in the payload:
smsPayload:
to: +61473123456
from: Default
body: "Hi Bob, your invoice INV-0001 is overdue. \n Please pay."
If the flag webhookOnly is true, then that means the email, sms etc was not actually sent to the contact, only this webhook event was triggered.
Escalations webhooks relate to the scheduled escalations on the escalations page. For example a phone call or a legal letter. The webhook will be sent when an escalation is marked as complete, or cancelled.
The content of the escalation webhook is JSON in this format:
contact:
accountingSystemId: c94a5733-bef8-432f-999d-372f94d10570
customerName: ABC Furniture
status: ACTIVE
primaryContactPerson:
isPrimaryContact: true
firstName: Bob
lastName: Jones
email: [email protected]
mobileNumber: 473123456
mobileCountryCode: 0061
contactPersons:
0:
isPrimaryContact: false
firstName: Trish
lastName: Rawlings
email: [email protected]
policy:
policyId: 82
policyTitle: letter after 30 days
policyType: escalation
invoice:
accountingSystemInvoiceId: 5f180e97-715a-48c2-84d6-496bbb8d18ab
invoiceReference: INV-0041
invoiceNumber: INV-0042
invoiceDueDate: 2024-01-23T00:00:00.000Z
invoiceCurrency: USD
invoiceTotal: 8888.58
invoiceBalanceDue: 8888.58
portalLink: https://example-portal-link.com
escalationType: letter
escalationId: 5
escalationStatus: complete
escalationNotes: [{note: test message, date: 2024-01-10T00:43:02.488Z, user: [email protected]}]
escalationEvent: note_added,
escalationDate: 2024-01-10T00:43:02.488Z
completedDate: 2024-01-10T00:43:28.529Z
Using Paidnice webhooks
In this example we'll show how you could create a Zap in Zapier that will receive a Paidnice webhook.
First create a new Zap and choose the Webhooks by Zapier option and use the Catch hook event:
Once you save you will receive a Zapier webhook URL like this:
Copy/paste the webhook URL into Paidnice and set it:
Now you can use actions in Zapier for any of the 100's of connected services. For example you could add a comment in your CRM that a late fee was applied, or a row in a Google spreadsheet.
This example shows how to use Zapier but the Paidnice webhook feature can work with any webhook integration in the same way as we've shown here.
Errors with your webhooks
If your webhook stops working Paidnice will disable it and you'll see this error in the web hook settings page:
Feedback
We'd love to have your feedback on webhooks - want more data? more events? Let us know, we want to enable your Accounts Receivable automation and would welcome feedback on how we can help.