Field NationDeveloper Platform
Field NationDeveloper Platform
Overview
Delete Webhook DELETEGet Webhook Details GETUpdate Webhook PUTList Webhooks GETCreate Webhook POST
Core Operations

Update Webhook

Update an existing webhook configuration, such as the endpoint URL, HTTP method, subscribed events, status, or notification email. Only the fields you include in the request body are changed; omitted fields keep their current values.

PUT
/api/v1/webhooks/{webhookId}

Authorization

bearer
AuthorizationBearer <token>

Standard HTTP Bearer authentication using JWT. Provide your API key in the Authorization header as 'Bearer '.

In: header

Path Parameters

webhookId*string

The webhookId parameter

Request Body

application/json

Updated webhook configuration. Only include fields that should be changed. Fields not included will remain unchanged.

events?array<>

Updated array of webhook event names to subscribe to. Replaces the existing event list. You can subscribe to 1, 2, or all 33 available events. Use the dropdown or type to select events. Valid event names include work order events (e.g., 'workorder.created', 'workorder.routed') and status changes (e.g., 'workorder.status.published', 'workorder.status.confirmed').

Items1 <= items
url?string

Updated HTTPS endpoint URL where webhook notifications will be sent. Must be a valid HTTPS URL.

Formaturi
method?string

Updated HTTP method to use for webhook delivery. Valid values are 'post' (recommended) or 'put'.

Value in"post" | "put"
status?string

Updated status of the webhook. 'active' enables notifications, 'inactive' pauses them, 'archived' deactivates the webhook.

Value in"active" | "inactive" | "archived"
notificationEmail?string

Updated email address to receive notifications about webhook delivery failures or important events.

Formatemail
secret?string

Updated secret key for signing webhook payloads. If provided, replaces the existing secret.

Formatuuid
isIntegrationOnly?boolean

Updated flag indicating whether this webhook is restricted to integration use only.

webhookAttribute?

Updated webhook attributes including custom headers and legacy field mappings. Use this to add or update custom headers that will be sent with each webhook delivery.

curl -X PUT "https://api-sandbox.fndev.net/api/v1/webhooks/string" \  -H "Content-Type: application/json" \  -d '{    "events": [      "workorder.created"    ],    "url": "http://example.org",    "method": "post",    "status": "active",    "notificationEmail": "user@example.org",    "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",    "isIntegrationOnly": true,    "webhookAttribute": {      "header": {        "test": "1254125",        "X-Custom-Header": "custom-value"      }    }  }'
{
  "metadata": {
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "result": {
    "id": 0,
    "webhookId": "string",
    "companyId": 0,
    "userId": 0,
    "events": [
      "string"
    ],
    "url": "string",
    "method": "post",
    "status": "active",
    "secret": "string",
    "notificationEmail": "string",
    "modelProperties": [
      "string"
    ],
    "isIntegrationOnly": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
{
  "metadata": {
    "timestamp": "2019-08-24T14:15:22Z",
    "path": "string"
  },
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "result": {}
}
{
  "metadata": {
    "timestamp": "2019-08-24T14:15:22Z",
    "path": "string"
  },
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "result": {}
}
{
  "metadata": {
    "timestamp": "2019-08-24T14:15:22Z",
    "path": "string"
  },
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "result": {}
}

Response Body

application/json

application/json

application/json

application/json

Last updated on

Get Webhook Details GET

Previous Page

List Webhooks GET

Next Page

curl -X PUT "https://api-sandbox.fndev.net/api/v1/webhooks/string" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [
      "workorder.created"
    ],
    "url": "http://example.org",
    "method": "post",
    "status": "active",
    "notificationEmail": "user@example.org",
    "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
    "isIntegrationOnly": true,
    "webhookAttribute": {
      "header": {
        "test": "1254125",
        "X-Custom-Header": "custom-value"
      }
    }
  }'