List Outgoing Webhooks

GET

/businesses/{businessId}/outgoing-webhooks

curl --request GET \
  --url https://api.upvio.com/v1/businesses/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/outgoing-webhooks \
  --header 'Authorization: Bearer <token>'

• production

List all outgoing webhooks within a business.

Authorizations

• apiKey

Parameters

Path Parameters

businessId

required

string format: uuid

Business ID

Responses

200

List of Outgoing Webhooks

Media typeapplication/json

object

data

Array<object>

Outgoing Webhook

Endpoint that receives events from Upvio.

object

id

required

Unique identifier across the platform.

string format: uuid

createdAt

Time when the resource was created (ISO 8601 format).

string format: date-time

updatedAt

Time when the resource was created (ISO 8601 format).

string format: date-time

enabled

required

Only enabled webhooks will receive events.

boolean

endpoint

required

The https:// URL that will receive events.

string

enabledEventNames

The events this webhook receives. An empty list falls back to the appointment events. See the webhooks section of this document for the payload delivered by each event.

Array<string>

Allowed values: appointment.create appointment.update appointment.delete appointment.request patient.create patient.update patient.archive patient.restore vitalsScan.create vitalsScan.complete vitalsScan.fail vitalsScan.abort

Example

{
  "data": [
    {
      "endpoint": "https://example.com/webhooks/upvio",
      "enabledEventNames": [
        "appointment.create"
      ]
    }
  ]
}

400

The request is invalid.

Media typeapplication/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: BadRequestError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 400,
    "type": "BadRequestError",
    "title": "Business ID does not match API key"
  }
}

403

The API key is missing or invalid, or the Business cannot be accessed with it.

Media typeapplication/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: UnauthorizedError BusinessArchivedError BusinessDisabledError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 403,
    "type": "UnauthorizedError",
    "title": "Invalid API token"
  }
}

404

The Business does not exist.

Media typeapplication/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: NotFoundError BusinessNotFoundError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 404,
    "type": "BusinessNotFoundError",
    "title": "Business not found"
  }
}