Skip to main content
Register Webhook Event
curl --request POST \
  --url https://api.yapily.com/webhook/events \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "applicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "categories": [
    "<string>"
  ],
  "callbackUrl": {
    "main": {
      "url": "<string>"
    },
    "backup": {
      "url": "<string>"
    }
  },
  "metadata": {}
}
'
{
  "metadata": {
    "tracingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "applicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "categories": [
      "<string>"
    ],
    "callbackUrl": {
      "main": {
        "url": "<string>"
      },
      "backup": {
        "url": "<string>"
      }
    },
    "metadata": {},
    "status": "active",
    "webhookSecret": "<string>"
  }
}
Learn more: Webhook Setup

Authorizations

​
Authorization
string
header
required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Headers

​
sub-application
string<uuid>

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

Body

application/json;charset=UTF-8
​
applicationId
string<uuid>
required
​
categories
string[]
required

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

​
callbackUrl
object
required

Callback URLs where events will be sent. These must not contain any query parameters.

​
metadata
object

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

​
metadata
object
​
data
object