This document is generated by Aladia.

Aladia API

Search Webhook Logs

Developing

GET

/webhooks/{webhookId}/logs/search

This endpoint use to retrieve the list of webhook logs that match the given query.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.aladia.io/v2/webhooks//logs/search?from&to&status&limit=50&next=&prev=' \
--header 'apikey: '

Response Example

{
  "cursor": {
    "prev": "string",
    "next": "string"
  },
  "data": [
    {
      "id": "670775694daebf393b266ea1",
      "webhookId": "670775694daebf393b266ea1",
      "responseCode": 0,
      "entityId": "670775694daebf393b266ea1",
      "ipAddress": "string",
      "source": {
        "id": "string",
        "type": "string",
        "email": "string"
      },
      "origin": "string",
      "createdAt": "2019-08-24",
      "updatedAt": "2019-08-24",
      "eventName": "string"
    }
  ]
}

Request

Path Params

webhookId

string

required

Query Params

from

string

optional

Time range start (ISO string).

string

optional

Time range end (ISO string).

status

string

optional

succeeded or failed

limit

integer

optional

Number of documents per page in the response

Default:

string

optional

Next token cursor, to navigate towards the next page

string

optional

Previous token cursor, to navigate towards the previous page

Header Params

apikey

string

optional

Example:

Responses

🟢200Success

application/json

Body

cursor

object

required

string | null

required

string | null

required

data

array[object (WebhookLog.rto) {10}]

required

string

required

unique Mongo id

Example:

670775694daebf393b266ea1

webhookId

string

required

webhook ID

Example:

670775694daebf393b266ea1

responseCode

number

required

status code returned

entityId

string

optional

id of the entity

Example:

670775694daebf393b266ea1

ipAddress

string

required

idAddress of source

source

object

required

user id of webhook event trigger

origin

string

required

webhook source url

createdAt

string <date>

required

date

updatedAt

string <date>

required

date

eventName

string

required

event type

Modified at 2025-04-09 10:13:59

Remove Webhook Logs

Create a Webhook