Create a webhook

To create a webhook, use the POST method. The POST body must contain specific options in JSON format.

Component Description

HTTP method

POST

URL

https://host/fmi/odata/version/database-name/Webhook.Add

host – FileMaker Cloud or FileMaker Server host name

version – the OData version, always v4

database-name – the name of the hosted database

Example: /fmi/odata/v4/ContactMgmt/Webhook.Add
Parameters

JSON example:

Copy 
{
  "webhook": "https://my.exmple.com:8080/webhook",
  "headers": {
    "Content-Type": "application/json"
  }, 
  "tableName": "myTable",
  "notifySchemaChanges": True,
  "select": "PrimaryKey,CreatedBy",
  "filter": "CreatedBy eq 'Admin'",
  //FileMaker Cloud
  "maxFailedAttempts": "10"
}

Notes 

  • FileMaker Cloud: maxFailedAttempts applies to the created webhook. Setting maxFailedAttempts to 0 indicates no maximum and that the webhook will retry sending the payload indefinitely until either the payload is received successfully or the webhook is deleted. Retry attempts are logged in the fmodata.log file.