๐
Introduction
๐ง
Platform
๐ฅ
Speedy Nodes
๐จโ๐ณ Tutorials
Webhooks
Define Custom Webhooks for Your Moralis Server.
Webhooks allow you to write your server-side logic in your own environment with any tools you wish to use. This can be useful if you want to use a language other than JavaScript, host it yourself for improved testing capabilities, or if you require a specialized library or technology not available in Moralis Cloud Functions.
Webhooks are currently available for
beforeSave, afterSave, beforeDelete, afterDelete, and cloud functions.Note: At the current time, custom webhooks cannot be set for the special classes _User and _Installation.
Cloud Function Webhooks
A webhook request for a cloud function will contain the following parameters:
- master: True if the master key was used and false otherwise.
- user: If set, this will contain the Moralis user who made the request, in our REST API format. This is not set if the master key is used.
- installationId: If available, the installationId which made the request.
- params: A JSON object containing the parameters passed to the function. For example:
{ "foo": "bar" }. - functionName: The name of the cloud function.
To respond to this request, send a JSON object with the key
error or success set.success: Send back any data your client will expect; or simplytrueif your client doesnโt require any data.error: The value provided should be the error message you want to return.
To create a webhook for a cloud function, start by writing the functionโs code on your own server.
You can activate a webhook from Dashboard as shown:
Create a custom webhook
Once the webhook is set, you can call it from the Moralis SDK, the same way you would with a normal cloud function.
Webhooks are great when you want to use a specialized technology not available using Moralis Cloud Functions.
beforeSave Webhooks
For triggers, the following parameters are sent to your webhook.
- master: True if the master key was used and false otherwise.
- user: If set, this will contain the Moralis user who made the request, in our REST API format.
- installationId: If available, the installationId which made the request.
- object: For triggers, this will contain the Moralis object, in our REST API format. For example:
{ "className": "TestObject", "foo": "bar" }. - triggerName: โbeforeSaveโ.
To respond to a
beforeSave request, send a JSON object with the key error or success set.This is the same as for cloud functions, but thereโs an extra capability with
beforeSave triggers. By returning an error, you will cancel the save request and the object will not be stored in Moralis. You can also return a JSON object in the following format to override the values that will be saved for the object:1
{
2
"className": "AwesomeClass",
3
"existingColumn": "sneakyChange",
4
"newColumn": "sneakyAddition"
5
}
Copied!
afterSave Webhooks
Like weโve seen in normal cloud functions, itโs also possible to run some code after an object has been saved using a webhook. The parameters sent to your webhook are the same as for
beforeSave triggers but weโll repeat them here for clarity.- master: True if the master key was used and false otherwise.
- user: If set, this will contain the Moralis user who made the request, in our REST API format.
- installationId: If available, the installationId which made the request.
- object: For triggers, this will contain the Moralis object, in our REST API format. For example:
{ "className": "TestObject", "foo": "bar" }. - triggerName: โafterSaveโ.
No response is required for
afterSave triggers.beforeDelete Webhooks
You also use webhooks for
beforeDelete triggers. The parameters sent to your webhook are the same as for beforeSave and afterSave triggers but weโll repeat them here for clarity.- master: True if the master key was used and false otherwise.
- user: If set, this will contain the Moralis user who made the request, in our REST API format.
- installationId: If available, the installationId which made the request.
- object: For triggers, this will contain the Moralis object, in our REST API format. For example:
{ "className": "TestObject", "foo": "bar" }. - triggerName: โbeforeDeleteโ.
Just as with cloud functions, to respond to a
beforeDelete request, send a JSON object with the key error or success set. Returning an error will cancel the delete and the object will remain in your database.afterDelete Webhooks
The
afterDelete trigger is also accessible via webhooks. The parameters sent to your webhook are the same as for other triggers but weโll repeat them here for clarity.- master: True if the master key was used and false otherwise.
- user: If set, this will contain the Moralis user who made the request, in our REST API format.
- installationId: If available, the installationId which made the request.
- object: For triggers, this will contain the Moralis object, in our REST API format. For example:
{ "className": "TestObject", "foo": "bar" }. - triggerName: โafterDeleteโ.
No response is required for
afterDelete triggers.Last modified 2mo ago