Hooks

PUT /hooks/subscriptions/{id}

Changed on

PUT operation for /hooks/subscriptions/{id}

put/hooks/subscriptions/{id}

Request

  • Base URL: https://dev-rest.onboard.io
  • URL: https://dev-rest.onboard.io/hooks/subscriptions/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

Request body

idinteger
targetstring uri required
event_type'map-created' | 'map-updated' | 'map-status-updated' | 'map-owner-updated' | 'map-custom-field-updated' | 'map-task-created' | 'map-task-updated' | 'map-task-assignee-updated' | 'map-task-due-date-updated' | 'map-task-status-updated' | 'map-section-completed' | 'customer-created' | 'customer-updated' | 'customer-custom-field-updated' | 'discussion-message-created' | 'team-member-created' | 'variable-created' | 'global-task-created' | 'workflow-completed' | 'custom-form-submitted' | 'document-completed' | 'document-voided' | 'fideo-verify-completed' required
versionstring
automatic_retryboolean
created_atstring date-time
descriptionstring
is_enabledboolean
is_salesforceboolean

Created via Salesforce integration

is_hubspotboolean

Created via HubSpot integration

custom_fieldstring

Response

Successful response

idinteger
targetstring uri required
event_type'map-created' | 'map-updated' | 'map-status-updated' | 'map-owner-updated' | 'map-custom-field-updated' | 'map-task-created' | 'map-task-updated' | 'map-task-assignee-updated' | 'map-task-due-date-updated' | 'map-task-status-updated' | 'map-section-completed' | 'customer-created' | 'customer-updated' | 'customer-custom-field-updated' | 'discussion-message-created' | 'team-member-created' | 'variable-created' | 'global-task-created' | 'workflow-completed' | 'custom-form-submitted' | 'document-completed' | 'document-voided' | 'fideo-verify-completed' required
versionstring
automatic_retryboolean
created_atstring date-time
descriptionstring
is_enabledboolean
is_salesforceboolean

Created via Salesforce integration

is_hubspotboolean

Created via HubSpot integration

custom_fieldstring

Changes

  • c64f0cb20b75Revision changes
    • warning

      added the new fideo-verify-completed enum value to the response property for the response status

    • info

      added the new fideo-verify-completed enum value to the request property