List all webhook's endpoints

GET /webhooks

This endpoint retrieves all your webhooks.

Responses

  • • 200 array[object]

    List of webhooks

    • _id string

      Unique identifier of the webhook

    • targetUrl string

      URL to which the webhook will send the data

    • status string

      Status of the webhook

    • createdAt string(date-time)

      Creation date of the webhook

    • secretToken string

      Secret token of the webhook

    • campaignId string

      Unique identifier of the campaign associated with the webhook

    • types array[string]

      Types of events that trigger the webhook

  • • 400

    Bad Request -- Your request is invalid.

  • • 401

    Unauthorized -- Your API key is wrong.

  • • 403

    Forbidden -- The object requested is hidden for administrators only.

  • • 404

    Not Found -- The specified object could not be found.

  • • 429

    Too Many Requests -- You're requesting too many objects! Slow down!

  • • 500

    Internal Server Error -- We had a problem with our server. Try again later.

  • • 503

    Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

GET /webhooks 
curl \
 -X GET https://api.usecollect.com/v1/webhooks \
 --user "username:password"
Response example (200) 
[
  {
    "_id": "HBsDeedGXx7BYbXwo",
    "targetUrl": "https://youserver.com/collect-hook",
    "status": "active",
    "createdAt": "2022-07-05 14:30:41 UTC",
    "secretToken": "gWg3fowgIgkc5KQvSojqWU"
  },
  {
    "_id": "mLASNBTu9n6vB6Zss",
    "targetUrl": "https://yourserver.com/collect-hook-two",
    "campaignId": "mYCsdgB4DQoENBaX6",
    "types": [
      "docUploadedformSubmited"
    ],
    "status": "active",
    "createdAt": "2022-07-06 15:21:15 UTC"
  }
]