Skip to main content
GET
/
api
/
v1
/
webhook_subscriptions
{
  "hydra:member": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>",
      "url": "<string>",
      "eventTypes": [
        "<string>"
      ],
      "headers": [
        "<string>"
      ],
      "isActive": true,
      "maxRetries": 3,
      "timeoutSeconds": 30,
      "tenant": "https://example.com/",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "lastTriggeredAt": "2023-11-07T05:31:56Z",
      "totalDeliveries": 123,
      "successfulDeliveries": 123,
      "failedDeliveries": 123,
      "description": "<string>",
      "metadata": [
        "<string>"
      ]
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Query Parameters

​
page
integer
default:1

The collection page number

​
pagination
boolean

Enable or disable pagination

​
name
string
​
url
string
​
eventTypes
string
​
tenant.id
integer
​
tenant.id[]
integer[]
​
isActive
boolean
​
order[id]
enum<string>
default:asc
Available options:
asc,
desc
​
order[name]
enum<string>
default:asc
Available options:
asc,
desc
​
order[createdAt]
enum<string>
default:asc
Available options:
asc,
desc
​
order[updatedAt]
enum<string>
default:asc
Available options:
asc,
desc
​
order[lastTriggeredAt]
enum<string>
default:asc
Available options:
asc,
desc
​
order[totalDeliveries]
enum<string>
default:asc
Available options:
asc,
desc
​
order[successfulDeliveries]
enum<string>
default:asc
Available options:
asc,
desc
​
order[failedDeliveries]
enum<string>
default:asc
Available options:
asc,
desc

Response

WebhookSubscription collection

​
hydra:member
object[]
required
​
hydra:totalItems
integer
Required range: x >= 0
​
hydra:view
object
Example:
{
  "@id": "string",
  "type": "string",
  "hydra:first": "string",
  "hydra:last": "string",
  "hydra:previous": "string",
  "hydra:next": "string"
}
​
hydra:search
object
⌘I