This document is generated by Aladia.

Aladia API

Test a Webhook

Developing

POST

/webhooks/{id}/test

This endpoint allows to test webhook by sending simulated events based on the specified eventTypes.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.aladia.io/v2/webhooks//test' \
--header 'apikey: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event": "string"
}'

Response Example

201 - Example 1

{
  "id": "string",
  "event": "string",
  "title": "string",
  "description": "string",
  "url": "string",
  "status": "string",
  "responseCode": 0,
  "data": {}
}

Request

Path Params

string

required

Header Params

apikey

string

optional

Example:

Body Params application/json

event

string

required

event type

Examples

Responses

🟢201Created

application/json

Body

string

required

webhook ID

event

string

required

webhook event types

title

string

required

title of webhook

description

string | null

required

description for webhook

url

string

required

webhook callback url

status

string

required

Enable/Disable

responseCode

number

required

response code of the webhook

data

required

Array of sample data for a specific event type

Any of

object

string

🔴500Server Error

🟠404Record Not Found

Modified at 2025-04-08 13:34:18

Delete a Webhook

Test a New Webhook