Events

Update a webhook endpoint

Changed on

Scope: account:manage. Acts on the account; keys bound to a customer are refused.

patch/v1/webhook-endpoints/{endpoint_id}

Request

  • Base URL: https://api.recruitmcp.com
  • URL: https://api.recruitmcp.com/v1/webhook-endpoints/{endpoint_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://recruitmcp.com/oauth/authorize, token URL https://recruitmcp.com/oauth/token, scopes: account:manage)

Path parameters

endpoint_idstring required

Headers

Idempotency-Keystring

Optional on this route. At most 128 characters. When present, the same key and body replays the first response for 24 hours. A different body is 409 idempotency_key_reused. A second call waits for the first and replays it. Omit the header to run the request normally.

RecruitMCP-Version'2026-10-13'

API version. Defaults to the version the key was created with. Supported: 2026-10-13.

Request body

urlstring

Public https URL. Private and loopback addresses are refused.

eventsstring[]

Default ["*"].

customer_idstring nullable
descriptionstring nullable
status'enabled' | 'disabled'

Example request

{
  "url": "https://hooks.example.com/recruitmcp",
  "events": [
    "job.completed",
    "reply.received"
  ]
}

Response

Updated.

idstring required
object'webhook_endpoint' required
urlstring required
eventsstring[] required

Event types, or ["*"] for all.

customer_idstring nullable

Only events from this customer.

descriptionstring nullable
status'enabled' | 'disabled' required
secret_hintstring

Start of the signing secret, to tell secrets apart.

created_atstring date-time
updated_atstring date-time

Changes

  • ad27b35513a6Revision changes
    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status