Webhooks

RankYak offers webhooks to notify your systems about important events. Webhooks are a way for RankYak to automatically send data to a URL you specify whenever a specific event happens. This allows you to integrate RankYak with your own applications and workflows.

Webhook Format

RankYak webhooks are sent as POST requests with a JSON payload. The content type of the request is application/json.

`article.published`

{
  "id": "unique-article-identifier",
  "slug": "article-url-slug",
  "excerpt": "First paragraph as a plain string without html or markdown",
  "title": "Article Title",
  "meta_title": "SEO Meta Title",
  "meta_description": "SEO Meta Description",
  "html": "<p>Article content in HTML format</p>",
  "markdown": "# Article Title\n\nArticle content in Markdown format",
  "header_image_url": "https://media.rankyak.com/example.png",
  "publish_at": "YYYY-MM-DDTHH:MM:SSZ",
  "published_at": "YYYY-MM-DDTHH:MM:SSZ"
}

​Webhook Format

​Webhooks

​article.published

Webhook Format

Webhooks

`article.published`