Sign in
Integrations

Activate Webhook Destination

Set the active status on a webhook integration destination.

Use this endpoint to activate or deactivate a webhook integration destination. It toggles the active status of the specific wehbook destination with the given ID.

put/organizations/{orgId}/integrationdestinations/webhooks/{id}/active

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

idstring required

The unique identifier (UUID) of the webhook destination. This ID is used to specify which webhook integration is being targeted for activation or deactivation.

Query parameters

activeboolean

active status of the webhook

Response

Returns the WebhookDestinationRequest

urlstring

The URL to which webhook requests are sent.

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
dtCreatedstring date-time

The DateTime when this item was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when this item was last modified (in ISO-8601 format).

createdBystring

The ID of the user who created this item.

lastModifiedBystring

The ID of the user who last modified this item.

namestring
descriptionstring
codestring
activeboolean

Example response

{
  "credentials": {
    "apiKey": "api key",
    "secret": "api secret"
  }
}

Changes

Changed in 2 of the 10 revisions of this API.314

  • 9f9e5f3dbde734See the full diff
    • ▲

      the response property credentials became optional for the status 200

      response-property-became-optional

    • ▲

      the response property url became optional for the status 200

      response-property-became-optional

    • ▲

      the url response property's minLength was decreased from 1 to 0 for the response status 200

      response-property-min-length-decreased

    • ○

      added DestinationResponse AbstractResponseWithAuditFields AbstractResponse to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      removed DestinationRequest AbstractRequest from the response body allOf list for the response status 200

      response-body-all-of-removed

    • ○

      added IntegrationM3terSignedCredentialsResponse to the credentials response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed IntegrationM3terSignedCredentialsRequest from the credentials response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b51See the full diff
    • ●

      added the new STRIPE_SIGNED_REQUEST enum value to the credentials/allOf[IntegrationM3terSignedCredentialsRequest]/allOf[IntegrationCredentialsRequestBase]/type response property for the response status 200

      response-property-enum-value-added

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog