API ReferenceHelp Center and Knowledge BaseDownload CLIGo to AppBook a Demo

Webhooks

post

Create webhook for an organization

🔒 Requires the create:webhook permission

Authorizations
Body
namestringRequired

The name of the webhook. e.g. New Production Deployment

scopestring · enumOptional

The scope (org/env/dep/bp) at which the included events will trigger the webhook. e.g. environment

Possible values:
scope_idstringOptional

The ID of the selected scope. e.g. 25cd0bd6-d09b-4924-abfb-41768d111fe7

endpoint_urlstringRequired

User defined end-point for pushing webhook. e.g. https://bluebricks.co/webhooks/deployment

is_enabledbooleanOptional

If webhook is active. e.g. true

Responses
200

Created webhook

application/json
post
/api/v1/webhook
POST /api/v1/webhook HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "name": "text",
  "scope": "organization",
  "scope_id": "text",
  "endpoint_url": "text",
  "is_enabled": true,
  "events": [
    "deployment:created"
  ]
}
{
  "id": "25cd0bd6-d09b-4924-abfb-41768d111fe7",
  "name": "New Production Deployment",
  "scope": "environment",
  "scope_id": "25cd0bd6-d09b-4924-abfb-41768d111fe7",
  "scope_slug": "production",
  "endpoint_url": "https://bluebricks.co/webhooks/deployment",
  "is_enabled": true,
  "created_by": "google-oauth2|1234567890",
  "created_at": "2025-11-10T15:43:37.194Z",
  "updated_at": null,
  "events": [
    "deployment:created",
    "deployment:updated"
  ]
}
get

Ability to get a webhook

🔒 Requires the read:webhook permission

Authorizations
Path parameters
webhookIdstring · uuidRequired

The webhook ID. e.g. 25cd0bd6-d09b-4924-abfb-41768d111fe7

Responses
200

Webhook information

application/json
get
/api/v1/webhook/{webhookId}
GET /api/v1/webhook/{webhookId} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "25cd0bd6-d09b-4924-abfb-41768d111fe7",
  "name": "New Production Deployment",
  "scope": "environment",
  "scope_id": "25cd0bd6-d09b-4924-abfb-41768d111fe7",
  "scope_slug": "production",
  "endpoint_url": "https://bluebricks.co/webhooks/deployment",
  "is_enabled": true,
  "created_by": "google-oauth2|1234567890",
  "created_at": "2025-11-10T15:43:37.194Z",
  "updated_at": null,
  "events": [
    "deployment:created",
    "deployment:updated"
  ]
}
put

Ability to update a webhook

🔒 Requires the update:webhook permission

Authorizations
Path parameters
webhookIdstring · uuidRequired
Body
namestringOptional

The name of the webhook. e.g. New Production Deployment

scopestring · enumOptional

The scope (org/env/dep/bp) at which the included events will trigger the webhook. e.g. environment

Possible values:
scope_idstringOptional

The ID of the selected scope. e.g. 25cd0bd6-d09b-4924-abfb-41768d111fe7

endpoint_urlstringOptional

User defined end-point for pushing webhook. e.g. https://bluebricks.co/webhooks/deployment

is_enabledbooleanOptional

If webhook is active. e.g. true

Responses
200

Updated webhook

application/json
put
/api/v1/webhook/{webhookId}
PUT /api/v1/webhook/{webhookId} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "name": "text",
  "scope": "organization",
  "scope_id": "text",
  "endpoint_url": "text",
  "is_enabled": true,
  "events": [
    "deployment:created"
  ]
}
{
  "id": "25cd0bd6-d09b-4924-abfb-41768d111fe7",
  "name": "New Production Deployment",
  "scope": "environment",
  "scope_id": "25cd0bd6-d09b-4924-abfb-41768d111fe7",
  "scope_slug": "production",
  "endpoint_url": "https://bluebricks.co/webhooks/deployment",
  "is_enabled": true,
  "created_by": "google-oauth2|1234567890",
  "created_at": "2025-11-10T15:43:37.194Z",
  "updated_at": null,
  "events": [
    "deployment:created",
    "deployment:updated"
  ]
}
delete

Delete webhook by id

🔒 Requires the delete:webhook permission

Authorizations
Path parameters
webhookIdstring · uuidRequired

The webhook ID. e.g. 25cd0bd6-d09b-4924-abfb-41768d111fe7

Responses
200

Deletion success status

application/json
delete
/api/v1/webhook/{webhookId}
DELETE /api/v1/webhook/{webhookId} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "25cd0bd6-d09b-4924-abfb-41768d111fe7"
}
get

List available webhooks for an organization

🔒 Requires the read:webhook permission

Authorizations
Query parameters
allbooleanOptional

Indicator to instruct the API if all or just active Webhooks. e.g. true

Default: true
filterstringOptional

Structure: [key1=value1,key2=value2&value3]

offsetnumberOptional

Results offset to allow pagination e.g. 10

Default: 0Example: 10
limitnumberOptional

Results limit to allow pagination, e.g. 50

Default: 20Example: 10
orderstringOptional

Specifies the order - ascending or descending - by which the returned list should be sorted e.g. ASC

sortstring · enumOptional

Specifies the attribute by which the returned list should be sorted. Can include the sort direction as ‘asc’ or ‘desc’. e.g. sort=name&order=asc

Default: created_atPossible values:
searchstringOptional

Enables searching within the list for webhook names that match a particular query. e.g. search=name

Responses
200

List of available webhooks

application/json
get
/api/v1/webhooks
GET /api/v1/webhooks HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 1,
  "stats": {
    "enable": 1
  },
  "list": [
    {
      "id": "25cd0bd6-d09b-4924-abfb-41768d111fe7",
      "name": "New Production Deployment",
      "scope": "environment",
      "scope_id": "25cd0bd6-d09b-4924-abfb-41768d111fe7",
      "scope_slug": "production",
      "endpoint_url": "https://bluebricks.co/webhooks/deployment",
      "is_enabled": true,
      "created_by": "google-oauth2|1234567890",
      "created_at": "2025-11-10T15:43:37.194Z",
      "updated_at": null,
      "events": [
        "deployment:created",
        "deployment:updated"
      ]
    }
  ],
  "filters": {
    "scopes": [
      "organization"
    ],
    "scope_ids": [
      "text"
    ],
    "endpoint_urls": [
      "text"
    ],
    "created_bys": [
      "text"
    ],
    "is_enabled": [
      "text"
    ],
    "events": [
      "text"
    ]
  }
}
PreviousUsersNextBricks MCP

Last updated

Was this helpful?