Webhooks API endpoints

PreviousWebhooks NextSample Postman collections

Last updated 3 months ago

Was this helpful?

Info for a specific webhook

get

Authorizations

Path parameters

idstringRequired

A unique numeric ID

Responses

get

GET /webhooks/{id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Accept: */*

{
  "events": [
    "did_create"
  ],
  "url": "https://webhook.example.io",
  "id": "text",
  "created": "2024-09-26T12:38:10.871Z",
  "secret": "text",
  "description": "My Webhook",
  "status": 0
}

Deletes a single webhook

delete

Authorizations

Path parameters

idstringRequired

A unique numeric ID

Responses

delete

DELETE /webhooks/{id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Accept: */*

No content

List all webhooks

get

Authorizations

Query parameters

offsetinteger · int32Optional

How many items to offset by for pagination

Default: 0

limitinteger · int32 · min: 1 · max: 64Optional

How many items to return at one time (max 64)

Default: 64

Responses

get

GET /webhooks HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Accept: */*

[
  {
    "events": [
      "did_create"
    ],
    "url": "https://webhook.example.io",
    "id": "text",
    "created": "2024-09-26T12:38:10.871Z",
    "secret": "text",
    "description": "My Webhook",
    "status": 0
  }
]

Create a Webhook

post

Authorizations

Body

urlstringRequired

The URL to send the webhook to

Example: https://webhook.example.io

descriptionstringOptional

The description of the webhook

Example: My webhook

statusinteger · enumOptional

The status of the webhook (0 = disabled, 1 = enabled)

Possible values:

Responses

post

POST /webhooks HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "url": "https://webhook.example.io",
  "description": "My webhook",
  "status": 0,
  "events": [
    "did_create"
  ]
}

{
  "events": [
    "did_create"
  ],
  "url": "https://webhook.example.io",
  "id": "text",
  "created": "2024-09-26T12:38:10.871Z",
  "secret": "text",
  "description": "My Webhook",
  "status": 0
}

Update a Webhook

patch

Authorizations

Path parameters

idstringRequired

A unique numeric ID

Body

urlstringRequired

The URL to send the webhook to

Example: https://webhook.example.io

descriptionstringOptional

The description of the webhook

Example: My webhook

statusinteger · enumOptional

The status of the webhook (0 = disabled, 1 = enabled)

Possible values:

Responses

patch

PATCH /webhooks/{id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "url": "https://webhook.example.io",
  "description": "My webhook",
  "status": 0,
  "events": [
    "did_create"
  ]
}

{
  "events": [
    "did_create"
  ],
  "url": "https://webhook.example.io",
  "id": "text",
  "created": "2024-09-26T12:38:10.871Z",
  "secret": "text",
  "description": "My Webhook",
  "status": 0
}