Edit

View as Markdown

PATCH
/workspaces
/:workspace
/integrations
/:hash_id

Update integration configuration

Request

REQUIRED SCOPES

INTEGRATION_MANAGE

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

hash_idrequiredstring

The hash ID of the integration

Example: "abc123def456"

POST PARAMETERS

identifierstring

A human-readable ID of the integration

namerequiredstring

The name of the integration

tokenstring

The authentication token for services like GitHub, GitLab, DigitalOcean

emailstring

Email address associated with the integration

api_keystring

The API key for services that use key-based authentication

access_keystring

The access key ID for AWS or DigitalOcean Spaces

secret_keystring

The secret access key for AWS or DigitalOcean Spaces

partner_tokenstring

Partner token for specific integrations

shopstring

The shop name for Shopify integrations

urlstring

The integration URL

chat_idstring

The chat ID for messaging integrations

git_hub_user_idstring

The GitHub user ID

git_hub_user_namestring

The GitHub username

usernamestring

The username for authentication

passwordstring

The password for Azure Cloud, UpCloud, or DockerHub

app_idstring

The application ID for Azure Cloud integrations

tenant_idstring

The tenant ID for Azure Cloud integrations

client_idstring

The client ID for OAuth-based integrations

client_tokenstring

The client token for authentication

server_idstring

The server ID for Discord integrations

server_tokenstring

The server token for authentication

key_idstring

The key ID for various integrations

application_keystring

The application key for Datadog integrations

host_urlstring

The host URL for custom integrations

webhook_addressstring

The webhook URL for receiving notifications

slack_user_idstring

The Slack user ID

regionstring

The cloud region (e.g., us-east-1, eu-west-1)

role_assumptionsRoleAssumptionView[]

AWS IAM role assumptions for cross-account access

all_pipelines_allowedboolean

Set to true to allow all pipelines to use this integration

allowed_pipelinesPipelineIdView[]

List of specific pipelines allowed to use this integration

permissionsIntegrationPermissionsView

Permission settings defining who can use this integration

auth_typestring enum

The authentication method used by the integration

Allowed enum:

OAUTH,

TOKEN,

API_KEY,

APP,

APP_SPRYKER,

TOKEN_APP_EXTENSION,

DEFAULT,

OIDC,

TRUSTED,

APP_RW

target_urlstring

The target URL for webhook-based integrations

refresh_tokenstring

The refresh token for OAuth flows

audiencestring

The JWT audience for token validation

configstring

Additional configuration data in JSON format

google_projectstring

The Google Cloud project ID

atop_urlstring

The ATOP service URL

Response

RESPONSE BODY

typestring enum

The type of integration

Allowed enum:

GIT_HUB,

BITBUCKET,

GOOGLE,

DIGITAL_OCEAN,

SLACK,

MODULUS,

HEROKU,

AMAZON,

GIT_LAB,

SHOPIFY,

GIT_HUB_ENTERPRISE,

GIT_LAB_ENTERPRISE,

PUSHOVER,

PUSHBULLET,

RACKSPACE,

CUSTOM,

CLOUDFLARE,

NEW_RELIC,

SENTRY,

ROLLBAR,

DATADOG,

DO_SPACES,

HONEYBADGER,

VULTR,

SENTRY_ENTERPRISE,

LOGGLY,

HIP_CHAT,

FIREBASE,

TELEGRAM,

AZURE,

UPCLOUD,

GHOST_INSPECTOR,

NETLIFY,

AZURE_CLOUD,

MICROSOFT_TEAMS,

GOOGLE_SERVICE_ACCOUNT,

GOOGLE_PLAY_STORE,

DOCKER_HUB,

APP_STORE,

GIT_HUB_APP,

GIT_HUB_APP_ENTERPRISE,

GIT_HUB_API,

ATOP,

SNYK,

STACK_HAWK,

BLACKFIRE,

BACKBLAZE,

ONE_LOGIN,

OKTA,

CONTENTFUL,

JIRA

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

identifierstring

A human-readable ID of the integration

hash_idstring

The unique hash ID of the integration

namestring

The name of the integration

auth_typestring enum

The authentication method used by the integration

Allowed enum:

OAUTH,

TOKEN,

API_KEY,

APP,

APP_SPRYKER,

TOKEN_APP_EXTENSION,

DEFAULT,

OIDC,

TRUSTED,

APP_RW

scopestring enum

The scope of the integration

Allowed enum:

WORKSPACE,

PROJECT,

ENVIRONMENT

project_namestring

The human-readable ID of the project (required when scope is PROJECT)

app_idstring

The application ID for Azure Cloud integrations

google_projectstring

The Google Cloud project ID

host_urlstring

The host URL for custom integrations

webhook_addressstring

The webhook URL for receiving notifications

audiencestring

The JWT audience for token validation

atop_urlstring

The ATOP service URL

permissionsIntegrationPermissionsView

Permission settings defining who can use this integration

all_pipelines_allowedboolean

Set to true to allow all pipelines to use this integration

allowed_pipelinesShortPipelineView[]

List of specific pipelines allowed to use this integration

Last modified on Jan 26, 2026

Get Delete

Request example


curl -X PATCH "https://api.buddy.works/workspaces/:workspace/integrations/:hash_id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "identifier": "GitHub",
  "name": "Updated GitHub Integration",
  "token": "ghp_yyyyyyyyyyyyyyyyyyyy",
  "all_pipelines_allowed": false,
  "allowed_pipelines": [
    {
      "id": 123
    },
    {
      "id": 456
    }
  ]
}'