Start free

Industries

Traders & distributors Retail shops Manufacturers Service businesses Pharma distributors Wholesalers Chartered Accountants All industries
Features Pricing Free tools Questions Help Contact us Log in

Send data in with webhooks

A webhook lets your website, online store or form tool create an opportunity, a draft quotation or a draft tax invoice in EaseDesk. Add one under Settings → Organisation → Webhooks, copy its URL and signing secret, and send signed JSON to it from your system.

In EaseDesk: Settings → Organisation → Webhooks. Log in or start a free trial.

Steps

  1. 1 Open Settings → Organisation and go to the Webhooks tab.
  2. 2 Click Add a webhook, give it a Name such as Website contact form, and choose What it does.
  3. 3 Click Add. Copy the URL and the Signing secret now; they are not shown again.
  4. 4 From your system, POST the JSON to the URL with the X-EaseDesk-Timestamp and X-EaseDesk-Signature headers.
  5. 5 Click Log on the webhook to see each request, with the record it made or the reason it was refused.

What a webhook can create

  • Create an opportunity: an enquiry from your website becomes an opportunity, and the enquirer is added to your Directory as a lead if they are new.
  • Create a draft quotation: a cart or a request for a quote becomes a draft for your team to check and send.
  • Create a draft tax invoice: an order from your online store becomes a draft invoice, ready to review and issue.

The JSON uses the same fields as the EaseDesk screen and is checked the same way, so a missing or wrong field comes back with a clear error.

The rules your developer needs

  • A POST with a JSON body of up to 256 KB.
  • X-EaseDesk-Timestamp: the time in Unix seconds, within 5 minutes of the server’s clock.
  • X-EaseDesk-Signature: sha256= followed by the HMAC-SHA256 of the timestamp, a full stop and the raw body, signed with the secret.
  • Up to 60 requests a minute for each webhook. A success answers 201 with the type and id of the record made.

The developers page has a full example.

Who it acts as

A webhook acts as the person who added it: what it makes shows as made by them, in the records and in the audit log, and it can do only what their role allows. Only the Owner and Admins can add webhooks. Use Switch off to pause one without deleting it.

Questions

Can a webhook issue an invoice on its own?

No. It creates a draft quotation or a draft tax invoice. Your team checks it and issues it in EaseDesk, so nothing reaches a customer without being seen first.

I lost the signing secret. What do I do?

Click New URL and secret on the webhook. The old URL and secret stop working, so update your system with the new ones.

Is there a full REST API?

Not yet. An open REST API with access tokens you can limit to parts of EaseDesk is coming soon, as are webhooks that tell your systems when an invoice is issued or a payment received.

Still stuck? WhatsApp or call +91 91525 20552 or write to support@easedesk.com. Updated .