Create an outgoing webhook for an app

POST /apps/{app-slug}/outgoing-webhooks

Create an outgoing webhook for a specified Bitrise app: this can be used to send build events to a specified URL with custom headers. Currently, only build events can trigger outgoing webhooks.

Path parameters

app-slug string Required

App slug

Body Required

App webhook creation params

events array[string] Required
headers object

Additional properties are allowed.
secret string Required
url string Required

Responses

200

OK
Hide response attribute Show response attribute object
- data object
  
  Additional properties are allowed.
  
  Hide data attributes Show data attributes object
  
  created_at string
  
  events array[string]
  
  headers object
  
  Additional properties are allowed.
  
  registered_by_addon boolean
  
  slug string
  
  updated_at string
  
  url string
400

Bad Request
Hide response attribute Show response attribute object
- message string
401

Unauthorized
Hide response attribute Show response attribute object
- message string
404

Not Found
Hide response attribute Show response attribute object
- message string
500

Internal Server Error
Hide response attribute Show response attribute object
- message string

POST /apps/{app-slug}/outgoing-webhooks

curl \
 --request POST 'https://api.bitrise.io/v0.1/apps/{app-slug}/outgoing-webhooks' \
 --header "Authorization: $API_KEY" \
 --data '{"events":["string"],"headers":{},"secret":"string","url":"string"}'

Request examples

{
  "events": [
    "string"
  ],
  "headers": {},
  "secret": "string",
  "url": "string"
}

Response examples (200)

{
  "data": {
    "created_at": "string",
    "events": [
      "string"
    ],
    "headers": {},
    "registered_by_addon": true,
    "slug": "string",
    "updated_at": "string",
    "url": "string"
  }
}

Response examples (400)

{
  "message": "string"
}

Response examples (401)

{
  "message": "string"
}

Response examples (404)

{
  "message": "string"
}

Response examples (500)

{
  "message": "string"
}