AppSkyline Webhook subscriptions API

openapi: 3.2.0
info:
  title: Appskyline Com Webhook subscriptions API
  version: 1.0.0
  x-api-versioning:
    currentVersion: '1'
    requestHeader: API-Version
    responseHeader: API-Version
    compatibilityPolicy: Omitting API-Version selects version 1. Unsupported versions return HTTP 400 with supportedVersions.
    deprecationPolicy: AppSkyline announces incompatible versions at least 180 days before removal. Deprecated responses include Deprecation, Sunset, and a Link relation named deprecation.
    deprecationHeaders:
    - Deprecation
    - Sunset
    - Link
    policyUrl: https://www.appskyline.com/api.md#compatibility-version
  description: 'Operations tagged Webhook subscriptions across 2 of this provider''s published API definitions: appskyline-api.swagger.json, appskyline-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.appskyline.com
tags:
- name: Webhook Subscriptions
paths:
  /api/webhooksubscriptions:
    get:
      tags:
      - Webhook Subscriptions
      summary: List webhook subscriptions
      description: 'Webhook subscriptions deliver `app.created`, `app.updated`, `keyword.created`, `keyword.updated` and `keyword.deleted` events to your server as signed POST requests (`X-Appskyline-Signature: t=,v1=`). An endpoint failing 20 times in a row is disabled automatically. Subscriptions are managed with an operator access token; the `secret` is only returned once, on create.'
      security:
      - accessToken: []
      responses:
        '200':
          description: Array of webhook subscriptions (without secrets)
      operationId: getApiWebhooksubscriptions
      x-codeSamples:
      - lang: Node + Request
        source: "const request = require('request');\n\nconst options = {\n  method: 'GET',\n  url: 'https://api.appskyline.com/api/webhooksubscriptions',\n  headers: {Authorization: 'REPLACE_KEY_VALUE'}\n};\n\nrequest(options, function (error, response, body) {\n  if (error) throw new Error(error);\n\n  console.log(body);\n});\n"
      - lang: Shell + Curl
        source: "curl --request GET \\\n  --url https://api.appskyline.com/api/webhooksubscriptions \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"
      - lang: Shell + Httpie
        source: "http GET https://api.appskyline.com/api/webhooksubscriptions \\\n  Authorization:REPLACE_KEY_VALUE"
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.appskyline.com")


          headers = { ''Authorization'': "REPLACE_KEY_VALUE" }


          conn.request("GET", "/api/webhooksubscriptions", headers=headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Php + Curl
        source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.appskyline.com/api/webhooksubscriptions\",\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_ENCODING => \"\",\n  CURLOPT_MAXREDIRS => 10,\n  CURLOPT_TIMEOUT => 30,\n  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n  CURLOPT_CUSTOMREQUEST => \"GET\",\n  CURLOPT_HTTPHEADER => [\n    \"Authorization: REPLACE_KEY_VALUE\"\n  ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n  echo \"cURL Error #:\" . $err;\n} else {\n  echo $response;\n}"
      - lang: Php + Http1
        source: "<?php\n\n$request = new HttpRequest();\n$request->setUrl('https://api.appskyline.com/api/webhooksubscriptions');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n  'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\ntry {\n  $response = $request->send();\n\n  echo $response->getBody();\n} catch (HttpException $ex) {\n  echo $ex;\n}"
      - lang: Php + Http2
        source: "<?php\n\n$client = new http\\Client;\n$request = new http\\Client\\Request;\n\n$request->setRequestUrl('https://api.appskyline.com/api/webhooksubscriptions');\n$request->setRequestMethod('GET');\n$request->setHeaders([\n  'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\n$client->enqueue($request)->send();\n$response = $client->getResponse();\n\necho $response->getBody();"
    post:
      tags:
      - Webhook Subscriptions
      summary: Create a webhook subscription
      description: The response includes the signing `secret` exactly once — store it; it cannot be retrieved again.
      security:
      - accessToken: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - url
              properties:
                url:
                  type: string
                  example: https://example.com/appskyline-webhook
                events:
                  type: array
                  description: Empty array subscribes to all events
                  items:
                    type: string
                    enum:
                    - app.created
                    - app.updated
                    - keyword.created
                    - keyword.updated
                    - keyword.deleted
      responses:
        '200':
          description: The created subscription, including its secret
      operationId: postApiWebhooksubscriptions
      x-codeSamples:
      - lang: Node + Request
        source: "const request = require('request');\n\nconst options = {\n  method: 'POST',\n  url: 'https://api.appskyline.com/api/webhooksubscriptions',\n  headers: {'content-type': 'application/json', Authorization: 'REPLACE_KEY_VALUE'},\n  body: {url: 'https://example.com/appskyline-webhook', events: ['app.created']},\n  json: true\n};\n\nrequest(options, function (error, response, body) {\n  if (error) throw new Error(error);\n\n  console.log(body);\n});\n"
      - lang: Shell + Curl
        source: "curl --request POST \\\n  --url https://api.appskyline.com/api/webhooksubscriptions \\\n  --header 'Authorization: REPLACE_KEY_VALUE' \\\n  --header 'content-type: application/json' \\\n  --data '{\"url\":\"https://example.com/appskyline-webhook\",\"events\":[\"app.created\"]}'"
      - lang: Shell + Httpie
        source: "echo '{\"url\":\"https://example.com/appskyline-webhook\",\"events\":[\"app.created\"]}' |  \\\n  http POST https://api.appskyline.com/api/webhooksubscriptions \\\n  Authorization:REPLACE_KEY_VALUE \\\n  content-type:application/json"
      - lang: Python + Python3
        source: "import http.client\n\nconn = http.client.HTTPSConnection(\"api.appskyline.com\")\n\npayload = \"{\\\"url\\\":\\\"https://example.com/appskyline-webhook\\\",\\\"events\\\":[\\\"app.created\\\"]}\"\n\nheaders = {\n    'content-type': \"application/json\",\n    'Authorization': \"REPLACE_KEY_VALUE\"\n    }\n\nconn.request(\"POST\", \"/api/webhooksubscriptions\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
      - lang: Php + Curl
        source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.appskyline.com/api/webhooksubscriptions\",\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_ENCODING => \"\",\n  CURLOPT_MAXREDIRS => 10,\n  CURLOPT_TIMEOUT => 30,\n  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n  CURLOPT_CUSTOMREQUEST => \"POST\",\n  CURLOPT_POSTFIELDS => \"{\\\"url\\\":\\\"https://example.com/appskyline-webhook\\\",\\\"events\\\":[\\\"app.created\\\"]}\",\n  CURLOPT_HTTPHEADER => [\n    \"Authorization: REPLACE_KEY_VALUE\",\n    \"content-type: application/json\"\n  ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n  echo \"cURL Error #:\" . $err;\n} else {\n  echo $response;\n}"
      - lang: Php + Http1
        source: "<?php\n\n$request = new HttpRequest();\n$request->setUrl('https://api.appskyline.com/api/webhooksubscriptions');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n  'content-type' => 'application/json',\n  'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\n$request->setBody('{\"url\":\"https://example.com/appskyline-webhook\",\"events\":[\"app.created\"]}');\n\ntry {\n  $response = $request->send();\n\n  echo $response->getBody();\n} catch (HttpException $ex) {\n  echo $ex;\n}"
      - lang: Php + Http2
        source: "<?php\n\n$client = new http\\Client;\n$request = new http\\Client\\Request;\n\n$body = new http\\Message\\Body;\n$body->append('{\"url\":\"https://example.com/appskyline-webhook\",\"events\":[\"app.created\"]}');\n\n$request->setRequestUrl('https://api.appskyline.com/api/webhooksubscriptions');\n$request->setRequestMethod('POST');\n$request->setBody($body);\n\n$request->setHeaders([\n  'content-type' => 'application/json',\n  'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\n$client->enqueue($request)->send();\n$response = $client->getResponse();\n\necho $response->getBody();"
    servers:
    - url: https://api.appskyline.com
  /api/webhooksubscriptions/{webhookSubscriptionId}:
    put:
      tags:
      - Webhook Subscriptions
      summary: Update a webhook subscription
      description: '`url`, `events` and `active` are editable; the secret and organization are immutable. Re-enabling an auto-disabled endpoint is done by setting `active` back to true.'
      security:
      - accessToken: []
      parameters:
      - in: path
        name: webhookSubscriptionId
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: The updated subscription (without secret)
      operationId: putApiWebhooksubscriptionsWebhookSubscriptionId
      x-codeSamples:
      - lang: Node + Request
        source: "const request = require('request');\n\nconst options = {\n  method: 'PUT',\n  url: 'https://api.appskyline.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D',\n  headers: {'content-type': 'application/json', Authorization: 'REPLACE_KEY_VALUE'},\n  body: {},\n  json: true\n};\n\nrequest(options, function (error, response, body) {\n  if (error) throw new Error(error);\n\n  console.log(body);\n});\n"
      - lang: Shell + Curl
        source: "curl --request PUT \\\n  --url https://api.appskyline.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE' \\\n  --header 'content-type: application/json' \\\n  --data '{}'"
      - lang: Shell + Httpie
        source: "echo '{}' |  \\\n  http PUT https://api.appskyline.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D \\\n  Authorization:REPLACE_KEY_VALUE \\\n  content-type:application/json"
      - lang: Python + Python3
        source: "import http.client\n\nconn = http.client.HTTPSConnection(\"api.appskyline.com\")\n\npayload = \"{}\"\n\nheaders = {\n    'content-type': \"application/json\",\n    'Authorization': \"REPLACE_KEY_VALUE\"\n    }\n\nconn.request(\"PUT\", \"/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
      - lang: Php + Curl
        source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.appskyline.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D\",\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_ENCODING => \"\",\n  CURLOPT_MAXREDIRS => 10,\n  CURLOPT_TIMEOUT => 30,\n  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n  CURLOPT_CUSTOMREQUEST => \"PUT\",\n  CURLOPT_POSTFIELDS => \"{}\",\n  CURLOPT_HTTPHEADER => [\n    \"Authorization: REPLACE_KEY_VALUE\",\n    \"content-type: application/json\"\n  ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n  echo \"cURL Error #:\" . $err;\n} else {\n  echo $response;\n}"
      - lang: Php + Http1
        source: "<?php\n\n$request = new HttpRequest();\n$request->setUrl('https://api.appskyline.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D');\n$request->setMethod(HTTP_METH_PUT);\n\n$request->setHeaders([\n  'content-type' => 'application/json',\n  'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\n$request->setBody('{}');\n\ntry {\n  $response = $request->send();\n\n  echo $response->getBody();\n} catch (HttpException $ex) {\n  echo $ex;\n}"
      - lang: Php + Http2
        source: "<?php\n\n$client = new http\\Client;\n$request = new http\\Client\\Request;\n\n$body = new http\\Message\\Body;\n$body->append('{}');\n\n$request->setRequestUrl('https://api.appskyline.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D');\n$request->setRequestMethod('PUT');\n$request->setBody($body);\n\n$request->setHeaders([\n  'content-type' => 'application/json',\n  'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\n$client->enqueue($request)->send();\n$response = $client->getResponse();\n\necho $response->getBody();"
    delete:
      tags:
      - Webhook Subscriptions
      summary: Delete a webhook subscription
      security:
      - accessToken: []
      parameters:
      - in: path
        name: webhookSubscriptionId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deleted
      operationId: deleteApiWebhooksubscriptionsWebhookSubscriptionId
      x-codeSamples:
      - lang: Node + Request
        source: "const request = require('request');\n\nconst options = {\n  method: 'DELETE',\n  url: 'https://api.appskyline.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D',\n  headers: {Authorization: 'REPLACE_KEY_VALUE'}\n};\n\nrequest(options, function (error, response, body) {\n  if (error) throw new Error(error);\n\n  console.log(body);\n});\n"
      - lang: Shell + Curl
        source: "curl --request DELETE \\\n  --url https://api.appskyline.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"
      - lang: Shell + Httpie
        source: "http DELETE https://api.appskyline.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D \\\n  Authorization:REPLACE_KEY_VALUE"
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.appskyline.com")


          headers = { ''Authorization'': "REPLACE_KEY_VALUE" }


          conn.request("DELETE", "/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D", headers=headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Php + Curl
        source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.appskyline.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D\",\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_ENCODING => \"\",\n  CURLOPT_MAXREDIRS => 10,\n  CURLOPT_TIMEOUT => 30,\n  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n  CURLOPT_CUSTOMREQUEST => \"DELETE\",\n  CURLOPT_HTTPHEADER => [\n    \"Authorization: REPLACE_KEY_VALUE\"\n  ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n  echo \"cURL Error #:\" . $err;\n} else {\n  echo $response;\n}"
      - lang: Php + Http1
        source: "<?php\n\n$request = new HttpRequest();\n$request->setUrl('https://api.appskyline.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D');\n$request->setMethod(HTTP_METH_DELETE);\n\n$request->setHeaders([\n  'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\ntry {\n  $response = $request->send();\n\n  echo $response->getBody();\n} catch (HttpException $ex) {\n  echo $ex;\n}"
      - lang: Php + Http2
        source: "<?php\n\n$client = new http\\Client;\n$request = new http\\Client\\Request;\n\n$request->setRequestUrl('https://api.appskyline.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D');\n$request->setRequestMethod('DELETE');\n$request->setHeaders([\n  'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\n$client->enqueue($request)->send();\n$response = $client->getResponse();\n\necho $response->getBody();"
    servers:
    - url: https://api.appskyline.com
components:
  headers:
    Deprecation:
      description: Present only when this API operation or version is deprecated. The value is an RFC 9745 Structured Field Date.
      schema:
        type: string
        example: '@1893456000'
    DeprecationLink:
      description: Present on deprecated responses and points to the applicable migration or deprecation policy with rel="deprecation".
      schema:
        type: string
        example: <https://www.appskyline.com/api.md#compatibility-version>; rel="deprecation"
    Sunset:
      description: Present on deprecated responses when a retirement date is scheduled. The value is an HTTP-date.
      schema:
        type: string
        example: Tue, 01 Jan 2030 00:00:00 GMT
  schemas:
    WebhookSubscription:
      type: object
      required:
      - _id
      - organizationId
      - url
      - active
      properties:
        _id:
          type: string
        organizationId:
          type: string
        url:
          type: string
          format: uri
        active:
          type: boolean
        events:
          type: array
          items:
            type: string
        secret:
          type: string
          description: Returned only when the subscription is created.
      additionalProperties: true
    DeleteResult:
      type: object
      required:
      - _id
      properties:
        _id:
          type: string
      additionalProperties: true
  securitySchemes:
    apiKey:
      type: http
      scheme: basic
      description: 'HTTP Basic auth carrying only the API key secret: `Authorization: Basic base64(<key secret>)`.'
    accessToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'Operator session token issued by the Appskyline dashboard: `Authorization: Token <access token>`.'
x-refined-from:
- appskyline-api.swagger.json
- appskyline-com-openapi.json