Webhooks

Register Webhook Event

Register a webhook to one or multiple event categories to receive real-time notifications when specific events occur in your application.

post/webhook/events

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Headers

sub-applicationstring uuid

The sub-application ID to which event type is being subscribed to

Request body

applicationIdstring uuid required
categoriesstring[] required

One or more event categories for which the webhook will be triggered

metadataWebhookMetadata

Any data (under 10kB total) that should be associated with the Webhook. A copy of this data will be returned on every Webhook trigger.

Response

Webhook Details

Changes

No recorded changes to this operation across all 4 revisions of this API.