Webhooks

In this guide, we will look at how to register and consume webhooks to integrate your app with ola.cv. With webhooks, your app can know when something happens in ola.cv.

Registering Webhooks

To register a new webhook, you need to have a URL in your app that ola.cv can call. You can configure a new webhook from the Ola.cv dashboard under API Settings > Webhooks and add your Webhook URL.

Consuming Webhooks

When your app receives a webhook request from ola.cv, check the type attribute to see what event caused it. The first part of the event type will tell you the payload type, e.g., sites.updated, etc.

Sample Webhook Payload

{
  "type": "sites.created",
  "data": {
    "id": "487560937166983168",
    "name": "Jane Doe",
    "slug": "puts-box",
    "template": "professional-profile",
    "status": "pending",
    "domain": null,
    "domain_registered_at": null,
    "created_at": "2026-09-07T09:53:05.000000Z",
    "generated_at": null
  },
  "sent_at": "2026-09-07T09:53:05+00:00"
}

In the example above, a site was created, and the payload type is a sites.created.


Event types

Whenever a request is unsuccessful, the ola.cv API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Here are some of the webhook you may encounter while working with the API.

  • Name
    sites.created
    Description

    A new site was created.

  • Name
    sites.status_updated
    Description

    An existing site's status was updated.

  • Name
    sites.updated
    Description

    An existing site was updated.

Was this page helpful?