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

List Webhooks

Retrieve a paginated list of webhooks configured for your company, with filters for status, search, sorting, and selected fields. Use this endpoint to quickly review and manage existing webhook configurations.

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

Query Parameters

sortDirection?string

Sort direction for the results. Use 'ASC' for ascending order or 'DESC' for descending order. Default is 'DESC'.

sortBy?string

Field name to sort results by. Valid values are 'id', 'webhookId', 'updatedAt', or 'createdAt'. Default is 'id'.

page?number

Page number for pagination. Starts at 1. Default is 1.

perPage?number

Number of items to return per page. Default is 25 items. Maximum value varies by endpoint.

search?string

Search query string to filter results. Supports searching across relevant fields such as webhook ID, event names, or other searchable attributes.

fields?string

Comma-separated list of field names to include in the response. Only specified fields will be returned, reducing response size. Default includes all standard webhook fields.

Default"id,webhookId,companyId,userId,events,url,method,status,secret,notificationEmail,modelProperties,isIntegrationOnly,createdAt,updatedAt"
status?string

Filter webhooks by their current status. Valid values are 'active' (receiving notifications), 'inactive' (paused), or 'archived' (deactivated).

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

Unique identifier of the webhook to filter by. Use this to find a specific webhook or filter delivery logs by webhook.

curl -X GET "https://api-sandbox.fndev.net/api/v1/webhooks?sortDirection=string&sortBy=string&page=0&perPage=0&search=string&fields=id%2CwebhookId%2CcompanyId%2CuserId%2Cevents%2Curl%2Cmethod%2Cstatus%2Csecret%2CnotificationEmail%2CmodelProperties%2CisIntegrationOnly%2CcreatedAt%2CupdatedAt&status=active&webhookId=string"
{
  "metadata": {
    "timestamp": "2019-08-24T14:15:22Z",
    "count": 0,
    "total": 0,
    "query": {
      "sortDirection": "string",
      "sortBy": "string",
      "page": 0,
      "perPage": 0,
      "search": "string",
      "fields": [
        "string"
      ],
      "userId": "string"
    }
  },
  "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

Update Webhook PUT

Previous Page

Create Webhook POST

Next Page

curl -X GET "https://api-sandbox.fndev.net/api/v1/webhooks?sortDirection=string&sortBy=string&page=0&perPage=0&search=string&fields=id%2CwebhookId%2CcompanyId%2CuserId%2Cevents%2Curl%2Cmethod%2Cstatus%2Csecret%2CnotificationEmail%2CmodelProperties%2CisIntegrationOnly%2CcreatedAt%2CupdatedAt&status=active&webhookId=string"