Webhooks

Get Webhooks

get
Authorizations
Header parameters
api-versionstringOptional
Responses
200
Success
get
GET /Webhooks HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "url": "text",
    "events": [
      "text"
    ],
    "token": "text",
    "description": "text",
    "webhookStatus": "Enabled"
  }
]

Create Webhook

post
Authorizations
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
all ofOptional
Responses
201
Created
post
POST /Webhooks HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "url": "https://example.com",
  "events": [
    "text"
  ],
  "description": "text",
  "webhookStatus": "Enabled"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "text",
  "events": [
    "text"
  ],
  "token": "text",
  "description": "text",
  "webhookStatus": "Enabled"
}

Get Webhook by id

get
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
200
Success
get
GET /Webhooks/{id} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "text",
  "events": [
    "text"
  ],
  "token": "text",
  "description": "text",
  "webhookStatus": "Enabled"
}

Delete Webhook

delete
Authorizations
Path parameters
idstring · uuidRequired

The identifier of the webhook

Header parameters
api-versionstringOptional
Responses
200
Success
delete
DELETE /Webhooks/{id} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content
PreviousUsageNextDocumentation

Last updated

Was this helpful?