Modify/Increase Webhook Payload
Forum rules
- Check the documentation first. Before posting questions, please check the documentation to ensure it doesn't already cover what you need.
- No spam. All automated messages, advertisements, and links to competitor websites will be deleted immediately.
- Post in relevant sub-forums only. Messages posted in the wrong topic area will be removed and placed in the correct sub-forum by moderators.
- Respect other users. No flaming or abusing fellow forum members. Users who continue to post inflammatory, abusive comments will be deleted from the forum after two warnings are issued by moderators.
- Harassment. No threats or harassment of other users will be tolerated. Any instance of threatening or harassing behavior is grounds for deletion from the forums.
- Adult content. No profanity or pornography is allowed. Posts containing adult material will be deleted.
- Bandwidth. All images and signatures must be 500 x 500 pixels or smaller. Posts containing over-sized images and signatures will be removed.
- Illegal content. No re-posting of copyrighted materials or other illegal content is allowed. Any posts containing illegal content or copyrighted materials will be deleted.
Modify/Increase Webhook Payload
Greetings,
We are currently exploring the integration of Power Automate for the purpose of dispatching SMS and email notifications. This initiative is in response to the significant constraints encountered with the existing SimPro job update webhook, which notably lacks the capability to display the current status of a job. Consequently, this necessitates an additional API request for status confirmation. However, this approach introduces a challenge, as it could result in a substantial number of superfluous API calls daily. This is particularly problematic because notifications are only necessary for jobs of specific statuses.
Could you advise if there is a method to enhance the webhook's payload to include job status information? Alternatively, is there an existing webhook that provides real-time updates on job status changes? If these options are not viable, we would appreciate any recommendations for a feasible workaround. Given our awareness of the API's limit of 10 calls per second, and considering our various ongoing developments that require API access, could there also be a possibility to negotiate an increase in this rate limit?
Thank you for your assistance.
We are currently exploring the integration of Power Automate for the purpose of dispatching SMS and email notifications. This initiative is in response to the significant constraints encountered with the existing SimPro job update webhook, which notably lacks the capability to display the current status of a job. Consequently, this necessitates an additional API request for status confirmation. However, this approach introduces a challenge, as it could result in a substantial number of superfluous API calls daily. This is particularly problematic because notifications are only necessary for jobs of specific statuses.
Could you advise if there is a method to enhance the webhook's payload to include job status information? Alternatively, is there an existing webhook that provides real-time updates on job status changes? If these options are not viable, we would appreciate any recommendations for a feasible workaround. Given our awareness of the API's limit of 10 calls per second, and considering our various ongoing developments that require API access, could there also be a possibility to negotiate an increase in this rate limit?
Thank you for your assistance.
Re: Modify/Increase Webhook Payload
Hi abaxter,
You can subscribe to a separate webhook event for job status updates which will give you the ID of the job that has been updated and the new job status.
I hope this can help.
See setup here for Simpro
https://developer.simprogroup.com/apido ... /Web-Hooks
or through API here:
https://developer.simprogroup.com/apido ... b7ca63ba5d
Regards
You can subscribe to a separate webhook event for job status updates which will give you the ID of the job that has been updated and the new job status.
I hope this can help.
See setup here for Simpro
https://developer.simprogroup.com/apido ... /Web-Hooks
or through API here:
https://developer.simprogroup.com/apido ... b7ca63ba5d
Regards
Sindre
API Developer | Simpro Software Group
API Developer | Simpro Software Group
-
- Posts: 7
- Joined: Mon Jun 19, 2023 4:30 pm
- Location: London
Re: Modify/Increase Webhook Payload
Hi, simPRO Support,
Got a very similar issue.
Our middleware solution keeps simPRO synchronized with one of our client's systems.
When an operative creates a schedule, we update the client's system, but when the operative changes the status of the schedule to "travelling" or "on-site", etc., we have no way of knowing the ID of the schedule that has changed to update the status of the schedule/appointment in the client's system.
Given that jobs can have more than one schedule at the same time, we do not know what schedule has changed.
Can you help?
Regards,
Sergio Garcia-Gonzalez
Got a very similar issue.
Our middleware solution keeps simPRO synchronized with one of our client's systems.
When an operative creates a schedule, we update the client's system, but when the operative changes the status of the schedule to "travelling" or "on-site", etc., we have no way of knowing the ID of the schedule that has changed to update the status of the schedule/appointment in the client's system.
Given that jobs can have more than one schedule at the same time, we do not know what schedule has changed.
Can you help?
Regards,
Sergio Garcia-Gonzalez
-
- Posts: 147
- Joined: Tue Oct 26, 2021 3:11 am
Re: Modify/Increase Webhook Payload
Hi Sergio Garcia-Gonzalez,
You can subscribe to Schedules related events in setup of webhook subscription. We currently have the ability to send webhook notifications for Activity, Job, Lead and Quote related Schedules.
More info on webhooks can be found here
https://developer.simprogroup.com/apido ... /Web-Hooks
To subscribe events using API use the following end point
https://developer.simprogroup.com/apido ... b7ca63ba5d
You can subscribe to Schedules related events in setup of webhook subscription. We currently have the ability to send webhook notifications for Activity, Job, Lead and Quote related Schedules.
More info on webhooks can be found here
https://developer.simprogroup.com/apido ... /Web-Hooks
To subscribe events using API use the following end point
https://developer.simprogroup.com/apido ... b7ca63ba5d
Prem
API Developer | Simpro Software Group
API Developer | Simpro Software Group
-
- Posts: 7
- Joined: Mon Jun 19, 2023 4:30 pm
- Location: London
Re: Modify/Increase Webhook Payload
Hi PremMarkeli,
We are subscribed to the schedule-related events. See the image attached.
The problem is that those events do not have the Schedule ID that triggered the event.
Regards,
Sergio Garcia-Gonzalez
We are subscribed to the schedule-related events. See the image attached.
The problem is that those events do not have the Schedule ID that triggered the event.
Regards,
Sergio Garcia-Gonzalez
- Attachments
-
- Screenshot 2024-02-20 142754.jpg (42.29 KiB) Viewed 382 times
-
- Posts: 147
- Joined: Tue Oct 26, 2021 3:11 am
Re: Modify/Increase Webhook Payload
Hi Hi Sergio Garcia-Gonzalez,
Can you please share the webhook payload info that you have received via PM so we can look into it.
Regards.
Can you please share the webhook payload info that you have received via PM so we can look into it.
Regards.
Prem
API Developer | Simpro Software Group
API Developer | Simpro Software Group
-
- Posts: 7
- Joined: Mon Jun 19, 2023 4:30 pm
- Location: London
Re: Modify/Increase Webhook Payload
Sure, will do ASAP. Thanks a lot!
-
- Posts: 7
- Joined: Mon Jun 19, 2023 4:30 pm
- Location: London
Re: Modify/Increase Webhook Payload
Done, I've just sent you the PM as requested.
PremMarkeli wrote: ↑Wed Feb 21, 2024 12:04 am Hi Hi Sergio Garcia-Gonzalez,
Can you please share the webhook payload info that you have received via PM so we can look into it.
Regards.
Re: Modify/Increase Webhook Payload
Hi Sindre,Sindre wrote: ↑Mon Feb 12, 2024 11:58 pm Hi abaxter,
You can subscribe to a separate webhook event for job status updates which will give you the ID of the job that has been updated and the new job status.
I hope this can help.
See setup here for Simpro
https://developer.simprogroup.com/apido ... /Web-Hooks
or through API here:
https://developer.simprogroup.com/apido ... b7ca63ba5d
Regards
so the issue is that the pre-defined payload doesn't include the status code which is the bit of the information that we need and every time a job gets updated we need a minimum of 3 api calls just to get some basic information from a single job.
just want to clarify that there is no way to create a custom payload or modify a webhook payload?
if this is correct we would need an increase to our API call limits on our account as we may very well hit 10 calls a second with the volume of jobs and also the custom developments we have had to create to support simpros lack of features.
please PM me on whom to contact in simpro to put this request through of either custom webhook (which would be preferable) that would provide the status code when a job is updated or to increase the API call limits.
Thanks!
Re: Modify/Increase Webhook Payload
Hi abaxter27,
I can confirm that it's not possible to customise the payload for the webhooks in individual builds.
As you are aware, for job status this has been included in a separate webhook that triggers whenever the status of a job is being changed.
For questions on customisation or changes to your account please contact our Simpro helpdesk who will be able to guide you.
https://helpdesk.simprogroup.com/
Regards
I can confirm that it's not possible to customise the payload for the webhooks in individual builds.
As you are aware, for job status this has been included in a separate webhook that triggers whenever the status of a job is being changed.
For questions on customisation or changes to your account please contact our Simpro helpdesk who will be able to guide you.
https://helpdesk.simprogroup.com/
Regards
Sindre
API Developer | Simpro Software Group
API Developer | Simpro Software Group