Webhook

Configure webhooks and delivery settings.

Get organizations project webhooks

get
/organizations/{organizationId}/projects/{projectId}/settings/webhooks

Get organizations project webhooks by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
get
/organizations/{organizationId}/projects/{projectId}/settings/webhooks

Create a organization project webhook

post
/organizations/{organizationId}/projects/{projectId}/settings/webhooks

Create a organization project webhook by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
namestringRequired

Webhook name

Example: <name>
urlstringRequired

Webhook URL

Example: <url>
headersobjectOptional

Webhook headers

activebooleanOptional

Webhook active status

Default: trueExample: <active>
eventsstring[]Required

Webhook events

Example: ["deployment.build.created"]
Responses
201

OK

application/json
_idstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
namestring · min: 2 · max: 100Required

Project name

slugstring · min: 2 · max: 100Required

Slug

Pattern: ^[a-z0-9-]{2,100}$
descriptionstring · max: 255Optional

Project description

organizationstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
credentialobjectOptional
additionalCredentialsobjectOptional
statusstring · enumRequired

Project status

Default: draftPossible values:
lastActivityAtstring · date-timeRead-onlyOptional

Date

appIconUrlstringOptional

Project app icon URL

createdAtstring · date-timeRead-onlyRequired

Date

updatedAtstring · date-timeRead-onlyRequired

Date

post
/organizations/{organizationId}/projects/{projectId}/settings/webhooks

Get organizations a project webhook

get
/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId}

Get a organization project webhook by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
webhookIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
get
/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId}

Delete a project webhook

delete
/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId}

Delete a project webhook by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
webhookIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
delete
/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId}

No content

Update a project webhook

patch
/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId}

Update a project webhook by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
webhookIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
namestringOptional

Webhook name

Example: <name>
urlstringOptional

Webhook URL

Example: <url>
headersobjectOptional

Webhook headers

activebooleanOptional

Webhook active status

Default: trueExample: <active>
eventsstring[]Optional

Webhook events

Example: ["deployment.build.created"]
Responses
patch
/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId}

Last updated

Was this helpful?