Add a webhook

POST /webhooks
Basic auth

This endpoint add a new webhook. It returns the webhook object.

application/json

Body Required

  • targetUrl string Required

    The URL of the webhook endpoint.

  • types array[string]

    The list of events to enable for this endpoint.

    Values are created, statusChanged, portalSubmited, dueDateChanged, portalViewed, docUploaded, docDeleted, docParsed, itemApproved, itemRejected, itemReopened, itemCancelValidation, formSubmited, emailSent, emailClicked, emailBounced, emailOpened, emailMarkedAsSpam, emailBlocked, emailUnsub, smsSent, smsDelivered, smsClicked, smsFailed, or smsUndelivered.

  • campaignId string

    We'll call this endpoint only for this campaignId.

  • secretToken string

    If you specify a secret token, it will be sent with the hook request in the HTTP header.

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • _id string
    • targetUrl string
    • status string
    • createdAt string(date-time)
    • types array[string]

      Values are created, statusChanged, portalSubmited, dueDateChanged, portalViewed, docUploaded, docDeleted, docParsed, itemApproved, itemRejected, itemReopened, itemCancelValidation, formSubmited, emailSent, emailClicked, emailBounced, emailOpened, emailMarkedAsSpam, emailBlocked, emailUnsub, smsSent, smsDelivered, smsClicked, smsFailed, or smsUndelivered.

    • campaignId string

      We'll call this endpoint only for this campaignId.

    • secretToken string

      If you specify a secret token, it will be sent with the hook request in the HTTP header.
  • 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.

POST /webhooks 
curl \
 --request POST 'https://api.usecollect.com/v1/webhooks' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --data '{"types":["created","statusChanged","dueDateChanged"],"targetUrl":"https://yourserver.com/collect-hook","campaignId":"sGyGrNPDxQDy6ZRAm"}'
Request example 
{
  "types": [
    "created",
    "statusChanged",
    "dueDateChanged"
  ],
  "targetUrl": "https://yourserver.com/collect-hook",
  "campaignId": "sGyGrNPDxQDy6ZRAm"
}
Response examples (200) 
{
  "_id": "eqQkPdnqwN7J38QEx",
  "types": [
    "created",
    "statusChanged",
    "dueDateChanged"
  ],
  "status": "active",
  "createdAt": "2024-07-13T15:01:38Z",
  "targetUrl": "https://yourserver.com/collect-hook"
}