triggerProductIntegrationPingTest

Trigger ping tests for a product integration. Repeated triggers for the same integration and version within the cooldown window are rejected via userErrors (retry after the indicated seconds).

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:

    Scopes

    ROLE_CHANNEL_ADMIN

    ROLE_PARTNER

    ROLE_CHANNEL_PRODUCT_SUPPORT

    ROLE_DEVELOPER

    Arguments

    input TriggerProductIntegrationPingTestInput!

    Input to trigger ping tests for a product integration.

    TriggerProductIntegrationPingTestInput fields

    id ID!

    Unique identifier of the product integration.

    version String!

    Version of the product integration ("WORKING" or "PUBLISHED").

    eventTypes [EventType]

    Event types to exercise. Null entries and duplicates are ignored. When omitted or empty, all event types are tested (bounded to the EventType enum).

    Return Fields

    productIntegration ProductIntegration

    Attributes of the product integration.

    userErrors [TriggerProductIntegrationPingTestError!]

    List of errors found during the ping tests (null if there are no errors).

    Interactive example

    This is an example mutation query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.