Workiom Webhooks

It's how Workiom tells your accounting app when your invoice is ready, how you can send a notification on Slack when a feedback record is added through forms.
‍

‍
How to use Webhooks?

There are some APIs in Workiom to use them for webhooks.
‍

‍
Resources:

The API endpoint is available at https://api.workiom.com.
A full example about how Can you Integrate Workiom API with Pabbly Workflow,
‍

‍
Event Type:

Set: eventType: 0; (When Record created)eventType: 1; (When Record Updated)
‍

‍
Workiom APIs:

‍
Sample:
curl -X POST "https://api.workiom.com/api/services/app/WebhookSubscription/AddSubscription" -H "accept: text/plain" -H "Content-Type: application/json-patch+json" -H -H "X-API-KEY={UP6tlj+kHsBCgkUcK/2xd1dB7NACAf64UU1WNsn7niYTjILq29+7/7h5rrAl1zyNGoO3uI1O8MeibOThuy5gk8gmMIVd308n1UhVQXWlGLg=}" -d "{ "appId":"{You can find it from your tenant url}", "listId":"{You can find it from your tenant url}", "name":"{Give a name }", "isActive":true, "webHook":"{The URL that will be triggered}", "eventType":0, "id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}"

‍

2. Get All Subscriptions

​/api​/services​/app​/WebhookSubscription​/GetAllSubscriptions

Sample:
curl -X GET "https://api.workiom.com/api/services/app/WebhookSubscription/GetAllSubscriptions" -H "accept: text/plain" -H "X-API-KEY={Your API Key}"

To get all subscriptions already configured in your tenant with your account.

‍

3. Get Subscription
‍

​/api​/services​/app​/WebhookSubscription​/GetSubscription

Sample:
curl -X GET "http://api.workiom.club:7777/api/services/app/WebhookSubscription/GetSubscription?subscriptionId=(your subscriptionId)" -H "accept: text/plain" -H "X-API-KEY={Your API Key}"

To get a subscription already configured in your tenant with your account.

‍

4. Delete Subscription
‍

/api/services/app/WebhookSubscription/DeleteSubscription

Sample:
curl -X DELETE "http://api.workiom.com/api/services/app/WebhookSubscription/DeleteSubscription?subscriptionId=(Your Subscription Id)" -H "accept: */*" -H "X-API-KEY={Your API Key}"

To Delete a subscription from your tenant with your account.

‍

5. Update Subscription
‍

/api/services/app/WebhookSubscription/UpdateSubscription

Sample:
curl -X PUT "http://api.workiom.com/api/services/app/WebhookSubscription/UpdateSubscription" -H "accept: */*" -H "Content-Type: application/json-patch+json" -H "X-API-KEY={Your API Key}" -d "{"appId\":\"Your App Id\","listId\":\"Your List Id\","name\":\"Use a name\","isActive\":true,"webHook\":\"The URL that will be triggered","eventType\":1,"id\":\"Subscription Id"}"

To update a subscription already configured in your tenant with your account.