Get all Webhooks of current application

GET 
/api/v2/public/webhooks/facility

Retrieves a list of all existing webhooks.

Request

Responses

201

application/json

Schema

Schema

data object[]
Array [
id stringrequired
If of the Webhook
url stringrequired
Url of the Webhook
events string[]required
Possible values: [shift.request.created, shift.request.cancelled, shift.report.created, shift.scheduled.cancelled, shift.scheduled, shift.created, shift.report.accepted-automatically, shift.report.accepted, shift.report.rejected, shift.cancelled, all]
List of events that this webhook will listen to
clientId stringrequired
facilities string[]required
List of facilities ids that this webhook belongs to
secrets string[]required
List of webhook secrets
]

Example (from schema)

{
  "data": [
    {
      "id": "9f08085c-9d51-49e6-bda0-e8b32e0f6605",
      "url": "https://exemple.com/webhook",
      "events": [
        "shift.report.created",
        "shift.request.created"
      ],
      "clientId": "string",
      "facilities": [
        "P-123456",
        "P-123457"
      ],
      "secrets": [
        "sDV1aKqitCLClI12m7UPFbAAvZfZquJw",
        "mryefgHPBVHJwux0o3BYW7hPM0BZlcCa"
      ]
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

message string

Error description

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Unauthorized",
  "statusCode": 401
}

403

Forbidden

application/json

Schema

Schema

message string

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Forbidden Resource",
  "error": "Forbidden",
  "statusCode": 403
}

Loading...