Legacy Docs

Ratings Webhooks

Sent when a rating has been added or updated.

#Added

post/v2/webhooks

The ratings.added webhook is sent when a new ratings object has been added for a user.

Request body
  • eventsarray of strings
    required

    ratings.added

  • namestring
    required

    Your name for the webhook subscription.

  • urlstring
    required

    Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.

  • secretstring
    optional

    Optional secret used to verify webhooks.

Webhook message
  • eventstring

    ratings.added

  • namestring

    Name used for the webhook subscription.

  • dataobject

  • accountstring

    ID of the account.

  • userstring

    ID of the user.

  • ratingstring

    ID of the rating.

Example Subscription
1curl --request POST \
2     --url https://api.argyle.com/v2/webhooks \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6        "events": ["ratings.added"],
7        "name": "name-for-the-webhook-subscription",
8        "url": "https://your-webhook-backend.com",
9        "secret": "optional-secret"
10     }'
Example Webhook
1{
2  "event": "ratings.added",
3  "name": "name-for-the-webhook-subscription",
4  "data": {
5    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
6    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7    "rating": "0176a5bd-6ed4-1a21-8661-32bc3546e6de"
8  }
9}

#Updated

post/v2/webhooks

The ratings.updated webhook is sent when there is any change to a property value of a ratings object.

Request body
  • eventsarray of strings
    required

    ratings.updated

  • namestring
    required

    Your name for the webhook subscription.

  • urlstring
    required

    Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.

  • secretstring
    optional

    Optional secret used to verify webhooks.

Webhook message
  • eventstring

    ratings.updated

  • namestring

    Name used for the webhook subscription.

  • dataobject

  • accountstring

    ID of the account.

  • userstring

    ID of the user.

  • ratingstring

    ID of the rating.

Example Subscription
1curl --request POST \
2     --url https://api.argyle.com/v2/webhooks \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6        "events": ["ratings.updated"],
7        "name": "name-for-the-webhook-subscription",
8        "url": "https://your-webhook-backend.com",
9        "secret": "optional-secret"
10     }'
Example Webhook
1{
2  "event": "ratings.updated",
3  "name": "name-for-the-webhook-subscription",
4  "data": {
5    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
6    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7    "rating": "0176a5bd-6ed4-1a21-8661-32bc3546e6de"
8  }
9}