Webhooks API endpoints

Create a Webhook

POSThttps://api-testnet.truvera.io/webhooks

Body

application/json

Webhook JSON object

url*string

The URL to send the webhook to

Example: "https://webhook.example.io"

descriptionstring

The description of the webhook

Example: "My webhook"

statusenum

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

01

events*array of enum

Response

200400402404

Webhook has been created

Body

application/json

events*array of enum

url*string

The URL to send the webhook to.

Example: "https://webhook.example.io"

id*NumericID (string)

A unique numeric ID

created*string

The timestamp when the webhook was created.

Example: "2024-09-26T12:38:10.871Z"

secret*string

The secret token of the webhook.

description*string

The description of the webhook.

Example: "My Webhook"

status*enum

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

01

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/webhooks', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "https://webhook.example.io",
      "events": [
        "did_create"
      ]
    }),
});
const data = await response.json();

Response

200400402404

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

List all webhooks

GEThttps://api-testnet.truvera.io/webhooks

Query parameters

Response

200400

A paged array of webhooks

Body

application/json

events*array of enum

url*string

The URL to send the webhook to.

Example: "https://webhook.example.io"

id*NumericID (string)

A unique numeric ID

created*string

The timestamp when the webhook was created.

Example: "2024-09-26T12:38:10.871Z"

secret*string

The secret token of the webhook.

description*string

The description of the webhook.

Example: "My Webhook"

status*enum

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

01

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/webhooks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

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

Info for a specific webhook

GEThttps://api-testnet.truvera.io/webhooks/{id}

Path parameters

id*NumericID (string)

A unique numeric ID

Response

200400404

A stored webhook JSON object

Body

application/json

events*array of enum

url*string

The URL to send the webhook to.

Example: "https://webhook.example.io"

id*NumericID (string)

A unique numeric ID

created*string

The timestamp when the webhook was created.

Example: "2024-09-26T12:38:10.871Z"

secret*string

The secret token of the webhook.

description*string

The description of the webhook.

Example: "My Webhook"

status*enum

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

01

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/webhooks/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "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

PATCHhttps://api-testnet.truvera.io/webhooks/{id}

Path parameters

id*NumericID (string)

A unique numeric ID

Body

application/json

Webhook JSON object

url*string

The URL to send the webhook to

Example: "https://webhook.example.io"

descriptionstring

The description of the webhook

Example: "My webhook"

statusenum

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

01

events*array of enum

Response

200400402

Webhook has been updated

Body

application/json

events*array of enum

url*string

The URL to send the webhook to.

Example: "https://webhook.example.io"

id*NumericID (string)

A unique numeric ID

created*string

The timestamp when the webhook was created.

Example: "2024-09-26T12:38:10.871Z"

secret*string

The secret token of the webhook.

description*string

The description of the webhook.

Example: "My Webhook"

status*enum

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

01

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/webhooks/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "https://webhook.example.io",
      "events": [
        "did_create"
      ]
    }),
});
const data = await response.json();

Response

200400402

{
  "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

DELETEhttps://api-testnet.truvera.io/webhooks/{id}

Path parameters

id*NumericID (string)

A unique numeric ID

Response

200400404

Webhook Deleted

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/webhooks/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400404

{
  "status": 0,
  "type": "text",
  "message": "text"
}