Receive a monday.com app lifecycle webhook
Accepts only monday.com's own lifecycle JWT in the Authorization header (401 otherwise), and answers 403 when the event data names another installer than...
POST/api/v1/monday.com/events/orgId
- Sign-in
- None at the router: the operation is public, or checks its own proof (a signature, a token in the body, a signed link).
- Rate limit
- Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted); up to 60 requests an hour per mondayActionLimiterKey.
Accepts only monday.com's own lifecycle JWT in the Authorization header (401 otherwise), and answers 403 when the event data names another installer than the signature. Stores the event, removes the account's tokens on uninstall, records user activity for a linked user, may create an unverified user for an unknown user_email, and forwards the event to the customer's configured URL without letting a failed forward fail the webhook.
Request
Path parameters
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
orgId | string | Yes | - | - |
Send the body as application/json. The body is optional.
Body
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
type | string | No | at most 128 characters | - |
data | object or null | No | - | - |
data.account_id | integer or string or null | No | at most 32 characters | - |
data.user_id | integer or string or null | No | at most 32 characters | - |
data.user_email | string or null | No | at most 320 characters | - |
data.user_name | string or null | No | at most 256 characters | - |
Example request
Replace each YOUR_... value with your own.
curl -X POST "https://api.console.buildbase.app/api/v1/monday.com/events/YOUR_ORG_ID" \
-H "Content-Type: application/json" \
-d '{
"type": "string",
"data": {
"account_id": 1,
"user_id": 1,
"user_email": "[email protected]"
}
}'const response = await fetch(
'https://api.console.buildbase.app/api/v1/monday.com/events/YOUR_ORG_ID',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
type: 'string',
data: {
account_id: 1,
user_id: 1,
user_email: '[email protected]',
},
}),
}
);
if (!response.ok) {
throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();import requests
response = requests.post(
"https://api.console.buildbase.app/api/v1/monday.com/events/YOUR_ORG_ID",
json={
"type": "string",
"data": {
"account_id": 1,
"user_id": 1,
"user_email": "[email protected]",
},
},
timeout=30,
)
response.raise_for_status()
data = response.json()Responses
200 OK
OK
{}Any other status
Any other answer the handler sends itself (its own refusals). Not described yet.
Errors
Each refusal, what it means, and what to do. The request changed nothing.
400 Bad Request
What it means: The request failed a validate() schema, or an id in the path is not a valid id. path names the field.
What to do: Fix the field the body names in path (or read message) and send the request again. Nothing was changed.
{
"error": true,
"success": false,
"path": "string",
"message": "string"
}404 Not Found
What it means: An id in the path names nothing in this org.
What to do: Check the ids in the path: one of them names nothing in this organization.
{
"success": false,
"message": "string"
}429 Too Many Requests
What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.
What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.
{
"success": false,
"message": "string",
"reason": "rate_limited",
"retryAfter": 1
}Related
- monday.com guide: how this part of BuildBase works
- All monday.com operations
- API reference: every operation, by tag
- Sign-in and credentials for the HTTP API
- How the HTTP API reports errors
- Make your first call
- Error codes: every
codethe API returns - OpenAPI: operation
mondayCom.events.createin public-v1.json