Skip to content

Commit

Permalink
Tidying up the hook docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
mpj17 committed Jun 19, 2015
1 parent 46b6714 commit 019c3f7
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions docs/hook.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Description
===========

The web hook ``gs-group-member-add.json``, in the **site** context,
adds a person to a group on the site.
adds a person to a group on the site.

* If the person is new to the system then a profile is created
and the person is added to the group.
Expand All @@ -33,15 +33,21 @@ Required arguments

.. option:: email=<address>

The email address of the new member.
The email address of the new *group* member. The email address
is used as the identifier for the person (see Returns_):

* If the email has never been seen by the system then a new
profile is created,
* Otherwise an existing profile is added to the group.

.. option:: fn=<name>

The name of the new member.

.. option:: add

The action (no value needs to be set, it must be present)
The action (no value needs to be set, but the argument must be
present).

Optional arguments
==================
Expand All @@ -64,8 +70,9 @@ Optional arguments
Returns
=======

On completion a JSON object is returned. The ``status`` and
``message`` fields are always set.
On completion a JSON object is returned. In the returned object
the :js:attr:`status` and :js:attr:`message` fields are always
set, with the :js:attr:`user` field usually set.

.. js:class:: Returns()

Expand Down

0 comments on commit 019c3f7

Please sign in to comment.