webhooks

Create a new Webhook

Note: Webhooks on a development domain (mockable.io, ngrok-free.app, ngrok-free.dev, on.aws, onrender.com, run.app, webhook.site) are automatically deleted when delivery returns a 404, 410, or 501 response. They are also deleted after retries are exhausted on a persistent connection error (timeout, DNS failure, connection refused, or a recognized persistent TLS certificate failure).

post/v1/webhooks

Request

Base URL
https://api.fieldguide.io
URL
https://api.fieldguide.io/v1/webhooks
Auth
HTTP bearer

Request body

descriptionstring required

scopesWebhookResource[] nullable

One or more resources to fire webhooks for. Available resources include comments, companies, engagements, milestones, requests, users. If null, webhooks will fire for all resources.

urlstring uri required

Example request

{
  "description": "Company XYZ Integration",
  "scopes": [
    "requests",
    "users"
  ],
  "url": "https://company-xyz.com/my-webhook-endpoint"
}

Response

The newly created Webhook

Example response

{
  "data": {
    "uuid": "d952a7a8-3f88-46d0-b4de-ec690d97105c",
    "description": "Firm internal systems",
    "scopes": [
      "requests",
      "users"
    ],
    "url": "https://company-xyz.com/my-webhook-endpoint",
    "created_at": "2023-01-01T12:30:00.000Z",
    "secret": "trN7inAfsWlDy8VeqVB3"
  }
}

Changes

No recorded changes to this operation across all 15 revisions of this API.