Webhook triggers

chriskrejler · 12 September 2023 11:12

I’d like to create a webhook that triggers on streamFavorite.

Is the list of triggers limited to the ones a user can set ind the FE?

Alternatively, does the stream_update trigger on user favorite?

jonathon · 12 September 2023 12:03

The webhook triggers listed in FE1 are by and large their limits.

specklesystems/speckle-server/blob/8063652dbf65b66ab99ed870d9e9f3be2ce81449/packages/frontend/src/main/components/stream/WebhookForm.vue#L127-L142


      
          allTriggers: [
            'stream_update',
            'stream_delete',
            'branch_create',
            'branch_update',
            'branch_delete',
            'commit_create',
            'commit_update',
            'commit_receive',
            'commit_delete',
            'comment_created',
            'comment_archived',
            'comment_replied',
            'stream_permissions_add',
            'stream_permissions_remove'
          ],

I’d have to test how many of the actions not hardcoded in the webhook form are also valid to be created by GraphQL:

github.com

specklesystems/speckle-server/blob/8063652dbf65b66ab99ed870d9e9f3be2ce81449/packages/server/modules/activitystream/helpers/types.ts#L25-L62


      
          export const ActionTypes = Object.freeze(<const>{
            Stream: {
              Update: 'stream_update',
              PermissionsRemove: 'stream_permissions_remove',
              PermissionsAdd: 'stream_permissions_add',
              InviteAccepted: 'stream_permissions_invite_accepted',
              Delete: 'stream_delete',
              Create: 'stream_create',
              Clone: 'stream_clone',
              InviteSent: 'stream_invite_sent',
              InviteDeclined: 'stream_invite_declined',
              AccessRequestSent: 'stream_access_request_sent',
              AccessRequestDeclined: 'stream_access_request_declined'
            },
            Comment: {
              Create: 'comment_created',
              Archive: 'comment_archived',
              Reply: 'comment_replied',
              Mention: 'comment_mention'
            },

This file has been truncated. show original

A users favourite streams, branches and commits is a property of the user, I don’t see any Activity triggers related to users beyond creation, update and deletion on user management.

What sort of workflow are you looking to support with such a webhook trigger, what would you like favouriting a stream/branch/commit to emit to?

chriskrejler · 13 September 2023 11:55

In the software we’re developing, we have a 1-1 relation between buildingprojects in our software and streams in Speckle. I was hoping that favorites in Speckle could trigger a webhook such that the buildingproject in our software would also be favourited, as we can do it the other way around through GraphQL.

But it seems that it’s not a problem atm, since the Revit connector doesn’t support favourites.

Thanks for the quick reply!

jonathon · 13 September 2023 12:04

Fair enough.

As Speckle is fully open-source, we are always happy to receive contributions where they extend the project in relevant ways.

Indeed, surfacing favourited content beyond the base frontend is very interesting as a UI/UX option.

@Agi has been seeking inputs like these, so I’m pinging here

Agi · 18 September 2023 06:54

Hello @chriskrejler,
Nice feedback! I would love to learn more about your interests and ideas regarding our product. Please book a call here to discuss this further: https://calendar.app.google/CdaA1i1bi6Y948Yf6
Thank you!

Thanks @jonathon for connecting us!