Endpoints

Webhooks

Webhooks allow you to integrate more deeply with Vrite and automate various tasks like publishing. They serve as customizable HTML callbacks that are triggered in response to various events, like a content piece being moved or a new member being added to the workspace. The API lets you create and manage webhooks associated with your workspace.

Retrieve Webhook

Retrieves details of the webhook specified by ID.

GET

/webhooks

Query Parameters

idstring

Required

ID of the webhook

Response object

idstring

ID of the webhook

urlstring

URL for the webhook to send data to

namestring

Name of the webhook

descriptionstring

Description of the webhook

contentGroupIdstring

ID of the content group the webhook event is connected with

eventstring

Event that triggers the webhook

contentPieceUpdatedcontentPieceAddedcontentPieceRemovedcontentGroupAddedcontentGroupRemovedcontentGroupMovedmemberInvitedmemberAddedmemberRemoved

extensionboolean

Whether the webhook is associated with an extension

Request

curl --request GET \
--url "https://api.vrite.io/webhooks?id={ID}" \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Accept: application/json'

const client = createClient({
  token: "<API_TOKEN>",
});
const result = await client.webhook.get({
  id: "1b396703e04491a752262178"
});

Response

{
  "id": "1b396703e04491a752262178",
  "url": "string",
  "name": "string",
  "description": "string",
  "metadata": {
    "contentGroupId": "4398d64edb8ac4db90de0f36"
  },
  "event": "contentPieceUpdated",
  "extension": true
}

List Webhooks

Lists existing webhooks. Supports pagination and filtering for webhooks associated with extensions.

GET

/webhooks/list

Query Parameters

perPagenumber

Number of webhooks to return per page

pagenumber

Page number to fetch

lastIdstring

Last webhook ID to starting fetching webhooks from

extensionOnlyboolean

Whether to only fetch webhooks associated with the extension

Response object[]

idstring

ID of the webhook

urlstring

URL for the webhook to send data to

namestring

Name of the webhook

descriptionstring

Description of the webhook

contentGroupIdstring

ID of the content group the webhook event is connected with

eventstring

Event that triggers the webhook

contentPieceUpdatedcontentPieceAddedcontentPieceRemovedcontentGroupAddedcontentGroupRemovedcontentGroupMovedmemberInvitedmemberAddedmemberRemoved

extensionboolean

Whether the webhook is associated with an extension

Request

curl --request GET \
--url "https://api.vrite.io/webhooks/list" \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Accept: application/json'

const client = createClient({
  token: "<API_TOKEN>"
});
const result = await client.webhooks.list({
  // Optional
  page: 1,
  // Optional
  perPage: 20,
  // Optional
  extensionOnly: true
});

Response

[
  {
    "id": "de2fb21ad4bbb929cf73ee5a",
    "url": "string",
    "name": "string",
    "description": "string",
    "metadata": {
      "contentGroupId": "ef69f28cc9538e5cb1580ea5"
    },
    "event": "contentPieceUpdated",
    "extension": true
  }
]

Create Webhook

Creates a webhook for the specified event with provided data.

POST

/webhooks

Body Parameters

urlstring

Required

URL for the webhook to send data to

namestring

Required

Name of the webhook

descriptionstring

Description of the webhook

secretstring

Secret for signing webhook payload

contentGroupIdstring

ID of the content group the webhook event is connected with

eventstring

Required

Event that triggers the webhook

contentPieceUpdatedcontentPieceAddedcontentPieceRemovedcontentGroupAddedcontentGroupRemovedcontentGroupMovedmemberInvitedmemberAddedmemberRemoved

Response object

idstring

ID of the webhook

Request

curl --request POST \
--url "https://api.vrite.io/webhooks" \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "url": "{URL}",
    "name": "{NAME}",
    "event": "{EVENT}"
}'

const client = createClient({
  token: "<API_TOKEN>",
});
const result = await client.webhooks.create({
  url: "string",
  name: "string",
  // Optional
  description: "string",
  // Optional
  secret: "string",
  // Optional
  metadata: {
    // Required for webhooks for "contentPiece*" events
    contentGroupId: "a70a17453ad260deb43e5192",
  },
  event: "contentPieceUpdated",
});

Response

{
  "id": "98ed3f1f2b861cd31f9cef16"
}

Update Webhook

Updates the webhook (including the event it’s registered for) with the provided data.

All properties except the secret of the webhook can be updated.

PUT

/webhooks

Body Parameters

idstring

Required

ID of the webhook

urlstring

URL for the webhook to send data to

namestring

Name of the webhook

descriptionstring

Description of the webhook

contentGroupIdstring

ID of the content group the webhook event is connected with

eventstring

Event that triggers the webhook

contentPieceUpdatedcontentPieceAddedcontentPieceRemovedcontentGroupAddedcontentGroupRemovedcontentGroupMovedmemberInvitedmemberAddedmemberRemoved

Response 200

Request

curl --request PUT \
--url "https://api.vrite.io/webhooks" \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "id": "{ID}"
}'

const client = createClient({
  token: "<API_TOKEN>",
});
await client.webhooks.update({
  id: "2294b5fd7eb27ec7c61675e1",
  url: "string",
  name: "string",
  description: "string",
  metadata: {
    contentGroupId: "636e825f62661160fb170413",
  },
  event: "contentPieceUpdated",
});

Delete Webhook

Deletes the webhook specified by ID.

DELETE

/webhooks

Query Parameters

idstring

Required

ID of the webhook

Response 200

Request

curl --request DELETE \
--url "https://api.vrite.io/webhooks?id={ID}" \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Accept: application/json'

const client = createClient({
  token: "<API_TOKEN>",
});
await client.webhooks.delete({
  id: "2294b5fd7eb27ec7c61675e1",
});

Variants

User Settings