Modifies the Source configuration for the specified pipeline_id. The available settings depend on the Source type.

Note: Use this endpoint if you cannot send a PATCH request. Otherwise, use the Modify Source Configuration in a Pipeline (PATCH) endpoint, which performs the same update.

In the request body, send only the values that you want to change, and send at least one of name, config or auth. Hevo keeps the current value of every field that you do not send. The config object holds the Source configuration fields for the connector, and you can send only the fields that the connector allows you to edit. Hevo rejects a field that cannot be edited even when the value you send is the same as the stored one.

To clear the value of a field, send that field as null. The connector then applies its default value for the field. A key that is not a field of the connector is not rejected and is stored as it is, so check your field names against the connector schema.

For a database Source, you can change only some fields, such as the password and the SSH tunnel and SSL settings. Refer to Changing a Source for the fields that you can change.

Hevo validates the change and runs a Source connection test before it saves the change, but only when the request changes config or sends auth. A change to only the name is not tested. A configuration that the Source rejects returns a 400 with the reason, and nothing is saved. The Pipeline stays in its current state, because the Source is edited on its own. A test that is still running after five minutes returns a 500.

To rotate the credentials of an OAuth Source without a browser sign-in, send the auth object with the following:

• The client_id and client_secret of your own OAuth app, under client_access.
• Any app-level credential that the provider requires.
• A refresh_token or an access_token.

Hevo exchanges them for a new token and tests it before it saves the change, so credentials that do not work leave the Source unchanged. If the test fails, Hevo revokes the new token. If the change succeeds, Hevo does not revoke the token that it replaces.

Sending auth for a connector that does not support OAuth, or for one that Hevo cannot authorize through the API, returns a 400, and Hevo rejects the whole request, including any config change in it. Update a connector that does not use OAuth through config, for example by sending a new database_password, and authorize the other kind in the Hevo UI. Credentials are never returned, so the response includes no Source configuration.

The following changes cancel the current authorization, so send auth in the same request:

• A change to config.authentication_method, even to a method that does not use OAuth.
• A change to a field that the provider uses to build the OAuth connection, such as a Salesforce account type or a Zendesk domain.

Sending auth rotates the credentials of an OAuth Source that Hevo can authorize through the API, whether it was authorized in the Hevo UI or through the API. No confirmation is needed.

Refer to Changing a Source for more information about the steps to change the Source settings and rotate its credentials.