Webhook Payloads Include Note ID

The payload of a 4me webhook now contains an extra bit of data to help developers build more efficient integrations. This extra piece of information is the ID of the note that was created during the event that triggered the webhook.

The benefit of having the ID of the new note immediately available in the payload is best explained with an example. Let’s assume that a developer is preparing a script that sends an email to a mailing list after the impact of a request is updated to ‘Top’. The email needs to contain the content of the note that the specialist who updated the impact level added to the request.

In the past, the webhook that would trigger on the event request.update would deliver its payload to the script so that it knows which request was updated. But the script would then need to make two REST API calls. The first to figure out whether a note was created when the request was updated and what its ID is, and the second to retrieve this note’s content. Now the script script can see the payload[note_id] parameter in the payload when a new note was added. The script can then simply obtain the content of this note with a single REST API call.

Detailed information about the Webhooks functionality can be found in 4me’s developer Documentation.