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

Get Webhook Details

Retrieve detailed information about a single webhook configuration, including subscribed events, status, and key settings. Use fields and webhookAttribute query parameters to control which core fields and additional attributes are returned.

GET
/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

Query Parameters

fields?string

Comma-separated list of field names to include in the response. Only specified fields will be returned. Default includes all standard webhook fields: id, webhookId, companyId, userId, events, url, method, status, secret, notificationEmail, modelProperties, isIntegrationOnly, createdAt, updatedAt.

webhookAttribute?string

Comma-separated list of webhook attribute types to include in the response. Valid values are 'legacy_field' (legacy field mappings) and 'header' (custom headers). Leave empty to exclude attributes.

Default""
curl -X GET "https://api-sandbox.fndev.net/api/v1/webhooks/string?fields=string&webhookAttribute="
{
  "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

Delete Webhook DELETE

Previous Page

Update Webhook PUT

Next Page

curl -X GET "https://api-sandbox.fndev.net/api/v1/webhooks/string?fields=string&webhookAttribute="