List all Webhook Executions

GET/v2/contributors/{contributorId}/webhook-executions/

API version

v2

Request method

GET

Operation ID

extension-list-all-extension-instance-webhook-executions

---

Request

• contributorIdstring

  required

Responses

Response headers

• X-Pagination-Limitinteger

  The limit used to select the resources for the response

• X-Pagination-Skipinteger

  The number of skipped items

• X-Pagination-Pagenumber

  The calculate page of the list response. Refer to parameters to learn more.

• X-Pagination-TotalCountinteger

  The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

Format

application/json

Description

A list of webhook executions.

Schema documentation

• Array[
  • *object
    • attemptsinteger

      required
    • contributorIdstring

      required
    • extensionIdstring (uuid)

      required
    • extensionInstanceIdstring (uuid)

      required
    • idstring (uuid)

      required
    • kindstring (one of: extensionAddedToContext, instanceUpdated, secretRotated, instanceRemovedFromContext)

      required
    • nextScheduledExecutionstring (date-time)
    • statestring (one of: running, queued, halted, failed, successful)

      required
  ]

Example

Content-Type: application/json

[
  {
    "attempts": 123,
    "contributorId": "string",
    "extensionId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "extensionInstanceId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "kind": "extensionAddedToContext",
    "nextScheduledExecution": "1985-10-26T01:21:00.000Z",
    "state": "running"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "attempts": {
        "type": "integer"
      },
      "contributorId": {
        "type": "string"
      },
      "extensionId": {
        "format": "uuid",
        "type": "string"
      },
      "extensionInstanceId": {
        "format": "uuid",
        "type": "string"
      },
      "id": {
        "format": "uuid",
        "type": "string"
      },
      "kind": {
        "enum": [
          "extensionAddedToContext",
          "instanceUpdated",
          "secretRotated",
          "instanceRemovedFromContext"
        ],
        "type": "string"
      },
      "nextScheduledExecution": {
        "format": "date-time",
        "type": "string"
      },
      "state": {
        "enum": [
          "running",
          "queued",
          "halted",
          "failed",
          "successful"
        ],
        "type": "string"
      }
    },
    "required": [
      "id",
      "extensionInstanceId",
      "extensionId",
      "contributorId",
      "kind",
      "state",
      "attempts"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/contributors/string/webhook-executions?extensionId=f0f86186-0a5a-45b2-aa33-502777496347&extensionInstanceId=f0f86186-0a5a-45b2-aa33-502777496347&limit=50&page=1&sort=attempts&order=asc

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.marketplace.extensionListAllExtensionInstanceWebhookExecutions({
  "contributorId": "string",
  "queryParameters": {
    "extensionId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "extensionInstanceId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "limit": 50,
    "page": 1,
    "sort": [
      "attempts"
    ],
    "order": [
      "asc"
    ]
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionListAllExtensionInstanceWebhookExecutions\ExtensionListAllExtensionInstanceWebhookExecutionsRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ExtensionListAllExtensionInstanceWebhookExecutionsRequest(
  contributorId: "string"
))
  ->withExtensionId("f0f86186-0a5a-45b2-aa33-502777496347")
  ->withExtensionInstanceId("f0f86186-0a5a-45b2-aa33-502777496347")
  ->withLimit(50)
  ->withPage(1)
  ->withSort(["attempts"])
  ->withOrder(["asc"]);
$response = $client->marketplace()->extensionListAllExtensionInstanceWebhookExecutions($request);

var_dump($response->getBody();