Lists the webhooks of a project.
HTTP
GET /projects/{projectId}/webhooksAccess: Session token only. API keys get 403 with insufficient_scope.
Role: Project manager (organisation owners and admins are managers of every project).
Path parameters #
| Parameter | Description |
|---|---|
projectId | The id of the project. |
Response 200 #
A list of webhooks.
JSON
[
{
"id": "0197a3c7-5e64-7b55-98ac-0c4f6d1b3e75",
"url": "https://example.com/hooks/translations",
"events": "All events",
"lastStatus": 200,
"ok": true,
"lastTriggeredMinutes": 30
}
]Response fields #
| Field | Type | Description |
|---|---|---|
id | string | The id of the webhook. |
url | string | Where requests are sent. |
events | string | The event it listens to, or All events. |
lastStatus | integer or null | The HTTP status of the last delivery. |
ok | boolean | Whether the last delivery worked. true when there was none yet. |
lastTriggeredMinutes | integer or null | Minutes since the last delivery. |
Errors #
| Status | error | When |
|---|---|---|
| 401 | unauthenticated | The token is missing or not valid. |
| 404 | not_found | The project does not exist in your organisation, you have no access to it, or projectId is not a UUID. |
| 403 | forbidden | You are a member of the project, but not a manager. |
| 429 | rate_limited | Too many requests, see Rate limiting. |
See Errors for the error format.
Notes #
For what a delivery looks like, see Webhooks.