Webhooks

People only, with webhooks.manage at reach Everyone. An integration's endpoint comes from its manifest; standalone endpoints are added here. See Webhooks for payloads, signatures and the event catalog.

All paths are relative to /api/v1. Key is the scope an integration key needs, People the permission a signed-in person or personal key needs, and Feature the feature switch the endpoint belongs to. See how to read this reference.

• GET/webhook-endpoints

  List endpoints; integrationId (or none for standalone) and status filter

  Key—not allowed

  Peoplewebhooks.manage (Everyone)
• POST/webhook-endpoints

  Add a standalone endpoint; returns its signing secret once

  Key—not allowed

  Peoplewebhooks.manage (Everyone)
• GET/webhook-endpoints/{id}

  Get an endpoint

  Key—not allowed

  Peoplewebhooks.manage (Everyone)
• PATCH/webhook-endpoints/{id}

  Change its URL, events or description, or disable and re-enable it

  Key—not allowed

  Peoplewebhooks.manage (Everyone)
• DELETE/webhook-endpoints/{id}

  Delete a standalone endpoint and its delivery log

  Key—not allowed

  Peoplewebhooks.manage (Everyone)
• POST/webhook-endpoints/{id}:rotate-secret

  New signing secret, returned once

  Key—not allowed

  Peoplewebhooks.manage (Everyone)
• POST/webhook-endpoints/{id}:ping

  Send a webhook.ping test event

  Key—not allowed

  Peoplewebhooks.manage (Everyone)
• POST/webhook-endpoints/{id}:retry-failed

  Queue every failed delivery again

  Key—not allowed

  Peoplewebhooks.manage (Everyone)
• GET/webhook-endpoints/{id}/deliveries

  Its deliveries; status, eventType and from filter

  Key—not allowed

  Peoplewebhooks.manage (Everyone)
• GET/webhook-deliveries/{id}

  A delivery with the event body exactly as sent

  Key—not allowed

  Peoplewebhooks.manage (Everyone)
• POST/webhook-deliveries/{id}:retry

  Send a delivery again

  Key—not allowed

  Peoplewebhooks.manage (Everyone)