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

Create Webhook

Create a new webhook configuration for your company by providing the target URL, HTTP method, subscribed events, and status. After creation, the webhook receives notifications for the selected events and is assigned a unique webhookId for future operations.

POST
/api/v1/webhooks

Authorization

bearer
AuthorizationBearer <token>

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

In: header

Request Body

application/json

Webhook configuration details including endpoint URL, HTTP method, events to subscribe to, status, and optional settings like secret and notification email.

events*array<>

Array of webhook event names to subscribe to. Must contain at least one event. You can subscribe to 1, 2, or all 33 available events.

Tip: In the JSON editor, you can enter events as a comma-separated string in the first array item (e.g., ["workorder.created,workorder.routed,workorder.status.published"]) and it will be automatically converted to an array. Or use the form view to add events one by one using the "+ New Item" button.

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

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

Formaturi
method*string

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

Default"post"
Value in"post" | "put"
status*string

Initial status of the webhook. 'active' will start receiving notifications immediately, 'inactive' creates it in paused state, 'archived' creates it deactivated.

Default"active"
Value in"active" | "inactive" | "archived"
secret?string

Optional secret key for signing webhook payloads. If provided, use this to verify incoming webhook requests. If omitted, a secret will be auto-generated.

Formatuuid
notificationEmail?string

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

Formatemail
isIntegrationOnly?boolean

Optional flag indicating whether this webhook is restricted to integration use only. If true, the webhook will only be accessible via API integrations.

Defaultfalse
webhookAttribute?

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

curl -X POST "https://api-sandbox.fndev.net/api/v1/webhooks" \  -H "Content-Type: application/json" \  -d '{    "events": [      "workorder.created",      "workorder.status.published"    ],    "url": "https://example.org/webhook",    "method": "post",    "status": "active",    "secret": "01999f51-5c66-4449-b441-6b4a053fee6a",    "notificationEmail": "webhook-admin@example.org",    "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

List Webhooks GET

Previous Page

List Webhook Events GET

Next Page

curl -X POST "https://api-sandbox.fndev.net/api/v1/webhooks" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [
      "workorder.created",
      "workorder.status.published"
    ],
    "url": "https://example.org/webhook",
    "method": "post",
    "status": "active",
    "secret": "01999f51-5c66-4449-b441-6b4a053fee6a",
    "notificationEmail": "webhook-admin@example.org",
    "isIntegrationOnly": true,
    "webhookAttribute": {
      "header": {
        "test": "1254125",
        "X-Custom-Header": "custom-value"
      }
    }
  }'