Skip to content

/AWS1/CL_PIP=>LISTWEBHOOKS()

About ListWebhooks

Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.

If a secret token was provided, it will be redacted in the response.

Method Signature

IMPORTING

Optional arguments:

iv_nexttoken TYPE /AWS1/PIPNEXTTOKEN /AWS1/PIPNEXTTOKEN

The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.

iv_maxresults TYPE /AWS1/PIPMAXRESULTS /AWS1/PIPMAXRESULTS

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

RETURNING

oo_output TYPE REF TO /aws1/cl_piplistwebhooksoutput /AWS1/CL_PIPLISTWEBHOOKSOUTPUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_pip~listwebhooks(
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_webhooks( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_webhookdefinition = lo_row_1->get_definition( ).
      IF lo_webhookdefinition IS NOT INITIAL.
        lv_webhookname = lo_webhookdefinition->get_name( ).
        lv_pipelinename = lo_webhookdefinition->get_targetpipeline( ).
        lv_actionname = lo_webhookdefinition->get_targetaction( ).
        LOOP AT lo_webhookdefinition->get_filters( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_jsonpath = lo_row_3->get_jsonpath( ).
            lv_matchequals = lo_row_3->get_matchequals( ).
          ENDIF.
        ENDLOOP.
        lv_webhookauthenticationty = lo_webhookdefinition->get_authentication( ).
        lo_webhookauthconfiguratio = lo_webhookdefinition->get_authntctnconfiguration( ).
        IF lo_webhookauthconfiguratio IS NOT INITIAL.
          lv_webhookauthconfiguratio_1 = lo_webhookauthconfiguratio->get_allowediprange( ).
          lv_webhookauthconfiguratio_2 = lo_webhookauthconfiguratio->get_secrettoken( ).
        ENDIF.
      ENDIF.
      lv_webhookurl = lo_row_1->get_url( ).
      lv_webhookerrormessage = lo_row_1->get_errormessage( ).
      lv_webhookerrorcode = lo_row_1->get_errorcode( ).
      lv_webhooklasttriggered = lo_row_1->get_lasttriggered( ).
      lv_webhookarn = lo_row_1->get_arn( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_tagkey = lo_row_5->get_key( ).
          lv_tagvalue = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.