Outgoing webhooks

Outgoing Webhooks integrations allow you to follow the activity of your circle from a tool configured to that.

Outgoing Wehbooks integrations of holaSpirit allow you to generate calls for the following triggers:

  • Project creation / update
  • Action creation / update
  • Checklist creation / update
  • Metric creation / update
  • Publication creation / update
  • Role and Circle creation / update / deletion
  • Policy creation / update / deletion
  • Assignation to Role

We will add other triggers in the next few weeks.

It's, for example, possible to use outgoing Webhooks with Zapier, to send information to any service supported by Zapier: https://zapier.com/zapbook/webhook/.

The integration consists in linking a circle on holaSpirit with a specific URL.

 

Link a circle to an outgoing Webhooks URL

To link circle's activities to an outgoing Webhook, go to the integrations of the circle and click on "create a new outgoing webhook".

 

 

Fill the URL given by the service and the Channel which is a name for your outgoing Webhook and submit.

 

Delete the link between a circle and an outgoing Webhook

If you want to delete the link between a circle and an outgoing Webhook, you just need to click on the trash near the concerned Webhook

 

Standard exchange (technical)

A POST call will be done after each events.

Data are encode in JSON, with this structures:

Project (creation/update) :

{
'object' : 'project',
'text' : 'description of the event', 'title' : 'title field of the project',
'body' : 'description field of the project',
'link' : 'link field of the project', 'circle' : 'id of the circle', 'author_name' : 'Name of member assigned to the project', 'role' : 'Name of the role', 'status' : 'current' or 'waiting' or 'future' or 'done', 'url' : 'Link to the project' }

Action (creation/update) :

{
'object' : 'action',
'text' : 'description of the event', 'title' : 'title field of the action',
'body' : 'description field of the action',
'link' : 'link field of the action', 'circle' : 'id of the circle', 'author_name' : 'Name of member assigned to the action', 'role' : 'Name of the role', 'status' : 'current' or 'done' }

Checklist (creation/update) :

{
'object' : 'checklist',
'text' : 'description of the event',
'title' : 'title field of the checklist',
'body' : 'description field of the checklist',
'link' : 'link field of the checklist',
'circle' : 'id of the circle',
'member' : 'Name of assigned members',
'role' : 'Name of the role',
'recurrence' : 'daily ... yearly',
'last_checked' : 'last time the checklist was checked during a tactical meeting'
}

Indicateur (creation/update)

{
'object' : 'metric',
'text' : 'description of the event',
'title' : 'title field of the metric',
'body' : 'description field of the metric',
'link' : 'link field of the metric',
'circle' : 'id of the circle',
'member' : 'Name of assigned members',
'role' : 'Name of the role',
'recurrence' : 'daily ... yearly',
'last_checked' : 'last time the metric was checked during a tactical meeting'
}

Publication (creation/update)

{
'object' : 'publication',
'text' : 'description of the event',
'title' : 'title field of the publication',
'body' : 'description field of the publication',
'link' : 'link field of the publication',
'circle' : 'id of the circle',
'member' : 'Name of assigned member',
'role' : 'Name of the role'
}

Policy (creation/update/deletion) :

{
'object' : 'policy',
'text' : 'description of the event',
'circle' : 'id of the circle',
'url' : 'Link to the policy in holaSpirit'
}

Role/Circle (creation/update/deletion) :

{
'object' : 'role',
'text' : 'description of the event',
'purpose' : 'purpose',
'circle' : 'id of the circle',
'url' : 'Link to the role/circle in holaSpirit',
* 'domains' : 'Domains, split by a carriage return',
* 'accountabilities' : 'Accountabilities, split by a carriage return'
}

* This fields aren't fill if they are empty

Election

{
'object' : 'corerole',
'text' : 'quickly description of the event',
'circle' : 'id of the circle',
'role' : 'name of the role',
'until' : 'end date (format: YYYY-MM-DD)',
'election' : 'complete description of the event',
'url' : 'Link to the role in holaSpirit'
} 

Assignation

{
'object' : 'assignation',
'text' : 'quickly description of the event',
'circle' : 'id of the circle',
'role' : 'name of the role',
'focus' : 'focus',
'assignation' : 'complete description of the event', 'url' : 'Link to the role in holaSpirit' }

 

 

Have more questions? Submit a request
Powered by Zendesk