Appendix H - Webhooks and Authentications

This topic introduces REST APIs related to webhooks and authentications used in Playblocks automations.

This topic provides REST APIs related to webhooks and authentications used in Playblocks automations.

Create Webhooks via API

This section describes how to create webhooks by using the API. It provides the method, URL, and request body structure with an example.

  • Method: POST

  • URL: https://cloudinfra-gw.portal.checkpoint.com/app/playblocks/api/v3/configuration/webhooks

  • Request Body Schema:

    {
            "name": string (required),
            "authenticationId": UUID (optional),
            "automationId": UUID (required),
            "expiration": Date (optional),
            "fieldsMapping": Object (optional)
            }

  • Request Body Example:

    {
            "name": "My webhook",
            "authenticationId": null,
            "automationId": "8fcec37b-0aa4-41f8-9a10-bed73f5a1360",
            "expiration": "2027-11-03T14:19:19.079Z",
            "fieldsMapping": {"src":"data.src"}
            }

View Required Fields for Trigger Output

To view the required fields in the automation trigger output (set mappings if required), use:

  • Method: GET

  • URL: /expectedTriggerOutput/{automationId}" scope="external">https://cloudinfra-gw.portal.checkpoint.com/app/playblocks/api/v3/configuration/automations/automation/expectedTriggerOutput/{automationId}

Response includes:

  • output: Defines the expected trigger output structure.

  • fieldsInUse: Lists the fields from the trigger output that are used in subsequent steps.

{
        "output": {
        "src": "1.2.3.4",
        "event_details": {"severity": "high"}
        },
        "fieldsInUse": ["src", "event_details.severity"]
        }

Retrieve your authentications via API

To retrieve your authentications, use these API:

  • Method: GET

  • URL: ations/automation/expectedTriggerOutput/{automationId}" scope="external">https://cloudinfra-gw.portal.checkpoint.com/app/playblocks/api/v3/configuration/automations/automation/expectedTriggerOutput/{automationId}

  • Response structure:

    {
            "success": true,
            "data": {
            "authentications": [
            {
            "id": "9824a0ee-eabe-48d6-aa14-43d4a1111111",
            "name": "My Authentication",
            "method": "Bearer Token",
            "type": "API Request",
            "parameters": {
            "token": <MY BEARER TOKEN>
            },
            "createdBy": "Playblocks System",
            "comment": "Create tickets permissions",
            "createdAt": "2025-08-27T14:29:32.975Z",
            "updatedAt": "2025-08-27T14:29:32.975Z"
            }
            ]
            }
            }