FIfieldguide
webhooks

Update the specified Webhook

patch/v1/webhooks/{uuid}

Request

  • Base URL
    https://api.fieldguide.io
  • URL
    https://api.fieldguide.io/v1/webhooks/{uuid}
  • Auth
    HTTP bearer

Path parameters

uuidstring uuid required

The UUID of the Webhook to update

Request body

descriptionstring
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.

Example request

{
  "description": "Company XYZ Integration",
  "scopes": [
    "requests",
    "users"
  ]
}

Response

The updated 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"
  }
}

Changes

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