RResumezBeta

Developer documentation

Webhooks

Published

Register HTTPS endpoints to receive events as they happen, instead of polling. Webhooks are managed with a client token.

Event types

profile.updatedThe canonical profile or one of its sub-resources changed.
artifact.generatedA new resume, cover letter, or bio finished generating.
artifact.updatedAn existing artifact was edited or republished.
generation.completedAn async generation job finished successfully.
generation.failedAn async generation job failed.
import.completedA resume, plaintext, or JSON import finished parsing.
export.completedAn artifact or profile export is ready for download.

Payload shape

Example delivery
{
  "id": "evt_...",
  "type": "artifact.generated",
  "createdAt": 1750000000000,
  "data": {
    "artifactId": "art_...",
    "kind": "resume"
  }
}

Every delivery is signed; verify the signature header against your endpoint's signing secret before trusting the payload.

Management endpoints

GET/v1/webhooks

List webhooks

Lists the caller's registered webhook endpoints.

Auth:oauth_userScopes:webhooks:manage
POST/v1/webhooks

Create webhook

Registers an HTTPS endpoint that receives the caller's domain events, HMAC-signed.

Auth:oauth_userScopes:webhooks:manage
DELETE/v1/webhooks/{webhookId}

Delete webhook

Removes a webhook endpoint.

Auth:oauth_userScopes:webhooks:manage