Webhooks

Update a webhook

Update a webhook by its encrypted id. Use this to point deliveries at a new URL, change which events are sent, rotate the signing secret (write-only — the new value is not echoed back, so keep what you set), or pause it by setting is_active to false — prefer pausing over deleting, since the webhook and its id survive. Send only the fields you want to change; anything omitted is left as-is. Two things to get right: event_filter is REPLACED, not merged, so send the complete list of event types you want, and passing event_filter: null widens the webhook to receive EVERY event type. Changing url redirects the user's data to a new destination, so confirm it with them first. Returns 404 if the webhook does not exist or belongs to someone else.

patch/v2/webhooks/{id}

Request

  • Base URL: https://api.village.ai
  • URL: https://api.village.ai/v2/webhooks/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Encrypted webhook identifier

Example:MLVEUadsfgzdsafsc10q5g%3D%3D!vNnNM

Request body

urlstring uri

HTTP(S) endpoint that receives the event payloads (HTTPS recommended). Must be publicly reachable and controlled by the user — localhost and private IP ranges are rejected.

descriptionstring

Human-readable label, so you can tell your webhooks apart later

secretstring

Your own HMAC signing secret (min 32 characters), used to sign every delivery so your endpoint can verify it really came from Village. Leave this out and Village generates one for you; either way the secret is readable via this API.

is_activeboolean

Set false to pause deliveries without deleting the webhook

event_filterstring[] nullable

Event types this webhook receives. Pass null (or omit on create) to receive EVERY event type, including ones added in future. Pass an explicit array to narrow it.

Example request

{
  "url": "https://example.com/hooks/village",
  "description": "Notify CRM on new connections",
  "secret": "a-32-character-or-longer-shared-secret",
  "event_filter": [
    "new_connection",
    "job_change"
  ]
}

Response

Webhook updated successfully

Example response

{
  "data": {
    "id": "MLVEUadsfgzdsafsc10q5g%3D%3D!vNnNM",
    "event_filter": [
      "new_connection"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.