Skip to content

LawVu Account (1.0)

Apis for account related resources (authentication, profiles, organisation details etc)

Download OpenAPI description
LawVu Account.openapi.json
LawVu Account.openapi.yaml
Languages
Servers
Sandbox API

https://api-sandbox.lawvu.com/account-apis/

Production API

https://api.lawvu.com/account-apis/

Auth

Operations

Emails

Operations

Features

Operations

Organisations

Operations

Recents

Operations

Users

Operations

WebhookSubscriptions

Operations

Create a subscription

Request

Create a webhook subscription to receive notifications on events occuring in LawVu

Body

Details of the webhook subscription to create

topicsArray of strings(WebhookTopicArray)required
Items Enum"matter.created""matter.updated""contract.created""contract.updated""matter.status.updated""contract.status.updated""matter.file.created""contract.file.created""matter.file.updated""contract.file.updated"
subscriptionUrlstring(uri)[ 1 .. 2048 ] charactersrequired

The publicly accessible URL of the endpoint which will be notified

clientStatestring or null<= 128 characters

A custom string which will be included with each notification to help identify the notification came from LawVu

{
  "topics": [
    "matter.created",
    "matter.updated",
    "matter.status.updated"
  ],
  "subscriptionUrl": "https://myapplication.com/incomingwebhooks",
  "clientState": "supersecretstring"
}

Responses

The ID of the created subscription

Body
integer(int32)
Response
No response example

Get all subscriptions

Request

Retrieve all existing webhook subscriptions

No request payload

Responses

Success

Body
Array [
idinteger(int32)
topicsArray of strings(WebhookTopicArray)
Items Enum"matter.created""matter.updated""contract.created""contract.updated""matter.status.updated""contract.status.updated""matter.file.created""contract.file.created""matter.file.updated""contract.file.updated"
subscriptionUrlstring or null
clientStatestring or null
statusstring or null
createdDateUtcstring(date-time)
createdBystring or null
modifiedDateUtcstring(date-time)
modifiedBystring or null
]
Response
[
  {
    "id": 1,
    "topics": [
      "matter.created",
      "matter.updated",
      "matter.status.updated"
    ],
    "subscriptionUrl": "https://myapplication.com/incomingwebhooks",
    "clientState": "supersecretstring",
    "status": "failed",
    "createdDateUtc": "2022-10-11T23:54:04.017",
    "createdBy": "461fffa2-950f-4961-b313-09fef67d419c",
    "modifiedDateUtc": "2022-12-19T23:54:04.017",
    "modifiedBy": "461fffa2-950f-4961-b313-09fef67d419c"
  },
  {
    "id": 2,
    "topics": [
      "contract.created"
    ],
    "subscriptionUrl": "https://myapplication.com/incomingwebhooks/example",
    "clientState": "my client state",
    "status": "active",
    "createdDateUtc": "2022-10-15T23:54:04.017",
    "createdBy": "461fffa2-950f-4961-b313-09fef67d419c",
    "modifiedDateUtc": "2022-12-21T23:54:04.017",
    "modifiedBy": "461fffa2-950f-4961-b313-09fef67d419c"
  }
]

Get a subscription

Request

Retrieve an existing webhook subscription

Path
idinteger(int32)required

The ID of the subscription

No request payload

Responses

Success

Body
idinteger(int32)
topicsArray of strings(WebhookTopicArray)
Items Enum"matter.created""matter.updated""contract.created""contract.updated""matter.status.updated""contract.status.updated""matter.file.created""contract.file.created""matter.file.updated""contract.file.updated"
subscriptionUrlstring or null
clientStatestring or null
statusstring or null
createdDateUtcstring(date-time)
createdBystring or null
modifiedDateUtcstring(date-time)
modifiedBystring or null
Response
{
  "id": 1,
  "topics": [
    "matter.created",
    "matter.updated",
    "matter.status.updated"
  ],
  "subscriptionUrl": "https://myapplication.com/incomingwebhooks",
  "clientState": "my client state",
  "status": "active",
  "createdDateUtc": "2022-10-11T23:54:04.017",
  "createdBy": "461fffa2-950f-4961-b313-09fef67d419c",
  "modifiedDateUtc": "2022-12-19T23:54:04.017",
  "modifiedBy": "461fffa2-950f-4961-b313-09fef67d419c"
}

Delete a subscription

Request

Deleting a webhook subscription will stop notifications for that subscription

Path
idinteger(int32)required

The ID of the subscription

No request payload

Responses

No Content