[Question] Does zenpy support getting list of webhook invocations filtered by status? about zenpy

[Ptr314]

Hi @akalex. But I tested it, and it worked. Just tested it again.

This code:

wh_filters = {
    'filter[from_ts]': '2023-12-04T12:00:00Z',
    'filter[to_ts]': '2023-12-04T16:00:00Z',
    'filter[status]': 'success',
}

for inv in zenpy.webhooks.invocations('01G00WWJ8VEMXSE31ENNJ6H2R9', **wh_filters):
    print(inv)

gives this debug output:

DEBUG:zenpy.lib.api:GET: https://pdi.zendesk.com/api/v2/webhooks/01G00WWJ8VEMXSE31ENNJ6H2R9/invocations?filter[status]=success&filter[to_ts]=2023-12-04T16:00:00Z&filter[from_ts]=2023-12-04T12:00:00Z - {'timeout': 60.0}
DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): pdi.zendesk.com:443
DEBUG:urllib3.connectionpool:https://pdi.zendesk.com:443 "GET /api/v2/webhooks/01G00WWJ8VEMXSE31ENNJ6H2R9/invocations?filter%5Bstatus%5D=success&filter%5Bto_ts%5D=2023-12-04T16:00:00Z&filter%5Bfrom_ts%5D=2023-12-04T12:00:00Z HTTP/1.1" 200 None
...
Invocation(id='01HGTF4QZGCE5E9VEPDWH2PFQK')
Invocation(id='01HGTF2X41Q0VS2HD5CR9TCA38')
Invocation(id='01HGTF26DHR5QZE0T0EEJ0AN4C')
Invocation(id='01HGTEMY6NS3FBW61XENWGJSXY')
Invocation(id='01HGTEDV4HBJFNWH54W7WDQ8KN')
DEBUG:zenpy.lib.generator:No more results available, stopping iteration

[Ptr314]

Hi! Hope fixed it here: #606 if @cryptomail won't mind, I'll merge it a bit later

[akalex]

Great. Thanks for your prompt response. Looking forward to getting it merged soon.

[Ptr314]

@akalex please try a new release. Docs are here.

[akalex]

Thanks, @Ptr314,
I am checking the new version and will come back to you shortly.

[akalex]

Hey @Ptr314,
I realized it has no effect because **kwargs gets passed into the wrong method. This is how it is supposed to look I believe

    @extract_id(Webhook)
    def invocations(self, webhook, **kwargs):
        """
        Get a webhook invocations

        :param webhook: a webhook to get invocations
        """

        url = self._build_url(endpoint=self.endpoint.invocations(id=webhook))
        return self._get(url, **kwargs)

In that case, I should be able to pass query parameters as follows.

client.webhooks.invocations("webhook_id", params={"filter[status]": "failed"})

[akalex]

Ok, I was wrong. It works.