List webhooks

GET

/organization_webhooks

curl --request GET \
  --url https://api.retorio.com/be/v2/organization_webhooks \
  --header 'Authorization: Bearer <token>'

Lists the webhooks configured for your organization, up to the limit of 5. No secret value is returned here: custom headers are listed by name only, and the signing secret is returned only by create and by an update that rotates it.

Authentication

Auth

Access key

Roles

Owner / Custom

Responses

200

OK

Media typeapplication/json

object

organizationWebhooks

required

Array<object>

object

extId

required

string

<= 64 characters

isEnabled

required

boolean

name

required

string

url

required

string

customHeaderNames

required

Array<string>

customHeadersUnreadable

required

True when the stored custom headers cannot be decrypted, in which case customHeaderNames is empty. While it is true, every delivery to this webhook, the test event included, fails and is not retried. Repair it with an update that sends every header with its value, or customHeaders: []. An entry without a value cannot be kept from an unreadable set, and the update answers 400.

boolean

subscribedEvents

required

Array<string>

Allowed values: coaching.result.available

lastChangedAt

required

string format: date-time

lastChangedBy

required

string

hasBeenEdited

required

boolean

Example

{
  "organizationWebhooks": [
    {
      "subscribedEvents": [
        "coaching.result.available"
      ]
    }
  ]
}

401

Not authenticated: the bearer token is missing, malformed, expired or revoked, its sign-in method does not match your organization’s configuration, the user it belongs to was removed, or your organization is deactivated.

Media typeapplication/json

object

message

required

string

status

required

Canonical error name, e.g. INVALID_ARGUMENT.

string

details

nullable

Example ^generated

{
  "message": "example",
  "status": "example",
  "details": "example"
}

403

Refused: the token does not belong to an admin, or the admin’s roles do not grant webhooks:manage.

Media typeapplication/json

Any of:

object

object

message

required

string

status

required

Canonical error name, e.g. INVALID_ARGUMENT.

string

details

nullable

object

object

statusCode

required

integer

message

required

string

error

required

The HTTP reason phrase, e.g. Bad Request.

string

Example ^generated

{
  "message": "example",
  "status": "example",
  "details": "example"
}

500

Internal Server Error

Media typeapplication/json

object

key

additional properties

nullable

Example ^generated

{
  "additionalProperty": "example"
}