Skip to main content

Webhooks

Manage webhooks for event notifications. Requires GHOST_ADMIN_API_KEY.

Tools​

ToolDescription
admin_create_webhookCreate a new webhook
admin_update_webhookUpdate an existing webhook
admin_delete_webhookDelete a webhook

admin_create_webhook​

Create a new webhook to receive event notifications.

{
  "event": "post.published",
  "target_url": "https://example.com/webhook",
  "name": "Post Published Notification"
}

Common events​

EventDescription
post.addedNew post created
post.deletedPost deleted
post.editedPost edited
post.publishedPost published
post.unpublishedPost unpublished
page.addedNew page created
page.deletedPage deleted
page.editedPage edited
page.publishedPage published
member.addedNew member added
member.deletedMember deleted
member.editedMember edited

Key parameters​

ParameterTypeDescription
eventstringEvent name (required)
target_urlstringWebhook URL (required)
namestringWebhook name
secretstringWebhook secret for verification

admin_update_webhook​

Update an existing webhook.

{
  "id": "6abc1234def5678901234567",
  "target_url": "https://new-url.example.com/webhook"
}

admin_delete_webhook​

Delete a webhook by its ID.

{
  "id": "6abc1234def5678901234567"
}