IntegrationDestinations

Update Destination

Changed on

Update a destination to be used for a webhook.

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

Request

Path parameters

orgIdstring required

UUID of the organization

idstring required

The UUID of the WebhookDestination to update.

Request body

urlstring required

The URL to which the webhook requests will be sent.

versioninteger

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
namestring required
descriptionstring required
codestring
activeboolean

Example request

{
  "credentials": {
    "name": "Integration Credentials",
    "apiKey": "api key",
    "secret": "api secret"
  }
}

Response

Returns the Destination Update Request

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

    • breaking

      the //// request property type changed from no type to object

    • breaking

      the ///// request property type changed from no type to object

    • breaking

      the / request property type changed from no type to object

    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the //////// response's property type changed from no type to object for status

    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the ///////// response's property type changed from no type to object for status

    • breaking

      the ///////////// response's property type changed from no type to object for status

    • breaking

      the ///////// response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      api tag IntegrationDestinations added

    • info

      api tag Integrations removed

    • info

      added the new GCP_WIF enum value to the request property /////////

    • info

      added the new SAGE_INTACCT_CLIENT_SECRET enum value to the request property /////////

    • info

      added the new SNS_REQUEST enum value to the request property /////////

    • info

      added the new STATIC_API_KEY enum value to the request property /////////

    • info

      added the new M3TER_APP_SIGNATURE enum value to the request property /////////

    • info

      added the new SAGE_INTACCT_CLIENT_CREDENTIALS enum value to the request property /////////

    • info

      added the new SLACK_WEBHOOK enum value to the request property /////////