C1c1st
RestHooks

Update subscription

Update the subscription for an event given an id.

put/hooks/{hookId}

Request

  • Base URL
    https://api.c1st.com/api
  • URL
    https://api.c1st.com/api/hooks/{hookId}
  • Auth
    HTTP bearer

Path parameters

hookIdinteger required

Request body

idinteger

A unique ID. Use this to handle this subscription.

eventstring

The event being listened for.

urlstring

The event being listened for.

receiverstring nullable

An identifier to distinguish different receivers.

active0 | 1

Whether or not the hook is enabled.

createdstring

Creation date of hook.

lastactivitystring nullable

Date of last time the hook got used.

last_updatedstring

The time the hook data was last updated

Example request

{
  "id": 123,
  "event": "product.created",
  "url": "https://hookb.in/Mqdd36mEeEUqaq6znxda",
  "receiver": "zapier",
  "active": 1,
  "created": "2019-01-01 12:00:00",
  "lastactivity": "2019-01-01 12:00:00",
  "last_updated": "2019-01-01 12:00:00"
}

Response

Ok

updatedinteger

Whether or not the event was updated. 0 for failure, 1 for success.

Example response

{
  "updated": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.