Webhook

Configure webhooks and delivery settings.

Get organizations project webhooks

get

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

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

Get organizations project webhooks by organization user

Authorizations

bearerAuthaccessToken

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

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organizationId}/projects/{projectId}/settings/webhooks HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "_id": "63ea10b94a472e003305232b",
    "name": "text",
    "url": "https://example.com",
    "headers": {},
    "active": true,
    "events": [
      "deployment.build.created"
    ],
    "createdAt": "2025-12-06T14:35:53.765Z",
    "updatedAt": "2025-12-06T14:35:53.765Z"
  }
]

Create a organization project webhook

post

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

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

Create a organization project webhook by organization user

Authorizations

bearerAuthaccessToken

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

application/json

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

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/v1/organizations/{organizationId}/projects/{projectId}/settings/webhooks HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "name": "<name>",
  "url": "<url>",
  "headers": {},
  "active": "<active>",
  "events": [
    [
      "deployment.build.created"
    ]
  ]
}

{
  "_id": "text",
  "name": "text",
  "slug": "text",
  "description": "text",
  "organization": "text",
  "credential": {},
  "additionalCredentials": {},
  "storeCredentials": {
    "googlePlay": {
      "googleServiceFile": "text",
      "packageName": "text"
    },
    "appleAppStore": {
      "keyId": "ABCDEFGHIJ",
      "keyIssuerId": "12345678-1234-1234-1234-123456789012",
      "apiKeyFile": "https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/b12ba00a-13ff-4e70-a2fc-41065b9d1e9d_b058caad-b7ba-4700-bb17-040206abb111_86851bc2-d08f-488c-9956-86ef6c7d5fc2_Akinon_shop_prod-(2)-(1).p8",
      "keyInHouse": true,
      "appIdentifier": "com.akinon.test",
      "teamId": "ABCDEFGHIJ",
      "teamName": "Akinon Team",
      "appSpecificId": 1234567890
    },
    "huaweiAppGallery": {
      "clientId": "text",
      "clientSecret": "text"
    }
  },
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      },
      "staging": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      }
    },
    "huawei": {
      "production": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      },
      "staging": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      }
    },
    "ios": {
      "production": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text"
      },
      "staging": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text"
      }
    }
  },
  "status": "draft",
  "lastActivityAt": "2025-12-06T14:35:53.765Z",
  "appIconUrl": "text",
  "createdAt": "2025-12-06T14:35:53.765Z",
  "updatedAt": "2025-12-06T14:35:53.765Z"
}

Get organizations a project webhook

get

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

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

Get a organization project webhook by organization user

Authorizations

bearerAuthaccessToken

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

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63ea10b94a472e003305232b",
  "name": "text",
  "url": "https://example.com",
  "headers": {},
  "active": true,
  "events": [
    "deployment.build.created"
  ],
  "createdAt": "2025-12-06T14:35:53.765Z",
  "updatedAt": "2025-12-06T14:35:53.765Z"
}

Delete a project webhook

delete

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

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

Delete a project webhook by organization user

Authorizations

bearerAuthaccessToken

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

204

No Content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

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

HTTPcURLJavaScriptPython

DELETE /api/v1/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a project webhook

patch

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

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

Update a project webhook by organization user

Authorizations

bearerAuthaccessToken

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

application/json

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

200

OK

application/json

Responseall of

and

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

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

HTTPcURLJavaScriptPython

PATCH /api/v1/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "name": "<name>",
  "url": "<url>",
  "headers": {},
  "active": "<active>",
  "events": [
    [
      "deployment.build.created"
    ]
  ]
}

{
  "_id": "text",
  "name": "text",
  "slug": "text",
  "description": "text",
  "organization": "text",
  "credential": {},
  "additionalCredentials": {},
  "storeCredentials": {
    "googlePlay": {
      "googleServiceFile": "text",
      "packageName": "text"
    },
    "appleAppStore": {
      "keyId": "ABCDEFGHIJ",
      "keyIssuerId": "12345678-1234-1234-1234-123456789012",
      "apiKeyFile": "https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/b12ba00a-13ff-4e70-a2fc-41065b9d1e9d_b058caad-b7ba-4700-bb17-040206abb111_86851bc2-d08f-488c-9956-86ef6c7d5fc2_Akinon_shop_prod-(2)-(1).p8",
      "keyInHouse": true,
      "appIdentifier": "com.akinon.test",
      "teamId": "ABCDEFGHIJ",
      "teamName": "Akinon Team",
      "appSpecificId": 1234567890
    },
    "huaweiAppGallery": {
      "clientId": "text",
      "clientSecret": "text"
    }
  },
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      },
      "staging": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      }
    },
    "huawei": {
      "production": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      },
      "staging": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      }
    },
    "ios": {
      "production": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text"
      },
      "staging": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text"
      }
    }
  },
  "status": "draft",
  "lastActivityAt": "2025-12-06T14:35:53.765Z",
  "appIconUrl": "text",
  "createdAt": "2025-12-06T14:35:53.765Z",
  "updatedAt": "2025-12-06T14:35:53.765Z"
}